# @starship-ci/types

> Starship Types

Latest version **4.0.0** (published 2025-12-11) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @starship-ci/types
pnpm add @starship-ci/types
yarn add @starship-ci/types
bun add @starship-ci/types
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2025-12-11 |
| First published | 2025-06-10 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 78 |
| Author | Anmol1696 |
| Maintainers | pyramation, anmol1696 |
| Keywords | blockchain, blockchain-simulation, blockchain-testing, TDD, multi-chain, crypto, cryptocurrency, ethereum, bitcoin, cosmos, smart-contracts, decentralized, DApps, web3, interchain |

## Links

- npm: https://www.npmjs.com/package/@starship-ci/types
- Repository: https://github.com/hyperweb-io/starship
- Issues: https://github.com/hyperweb-io/starship/issues
- npm.io page: https://npm.io/package/@starship-ci/types

## Dependencies (1)

- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) ^2.0.1

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2025-12-11
- 4.0.0-alpha.1 — 2025-08-20
- 4.0.0-alpha.0 — 2025-06-24
- 3.14.0 — 2025-06-11
- 3.12.0 — 2025-06-10

## 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

```sh
npm install @starship-ci/types
```

## Usage

```typescript
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 the [Constructive](https://constructive.io) team — makers of [Hyperweb](https://hyperweb.io)

---
_Source: https://npm.io/package/@starship-ci/types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
