Package Exports

@starship-ci/types
@starship-ci/types/esm/index.js
@starship-ci/types/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@starship-ci/types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@starship-ci/types

TypeScript type definitions for Starship configuration and components.

Overview

This package provides comprehensive TypeScript types for Starship configurations, ensuring type safety across all Starship packages and user configurations.

Installation

npm install @starship-ci/types

Usage

import { StarshipConfig, Chain, Relayer } from '@starship-ci/types';

const config: StarshipConfig = {
  name: 'my-starship',
  version: '1.8.0',
  chains: [
    {
      id: 'osmosis-1',
      name: 'osmosis',
      numValidators: 2,
      ports: {
        rest: 1313,
        rpc: 26653,
        faucet: 8003
      }
    }
  ],
  relayers: [
    {
      name: 'osmos-cosmos',
      type: 'hermes',
      replicas: 1,
      chains: ['osmosis-1', 'cosmoshub-4']
    }
  ]
};

Types Included

StarshipConfig - Main configuration interface
Chain - Blockchain configuration
Relayer - Relayer configuration
Explorer - Block explorer configuration
Registry - Chain registry configuration
Monitoring - Monitoring configuration
Ingress - Ingress configuration
Frontend - Frontend configuration
And many more...

Features

Type Safety: Comprehensive TypeScript definitions
Schema Alignment: Types match the values.schema.json exactly
Extensible: Easy to extend for custom configurations
Well Documented: JSDoc comments for all interfaces

Credits

🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to our github ⚛️