Class Compose

constructor

• new Compose(options?: Partial<Compose>): Compose

• Parameters

  • Optionaloptions: Partial<Compose>

  Returns Compose

envs

Optionalname

networks

secrets

services

Optionalversion

volumes

addBinding

• addBinding(binding: Binding, to: Service[]): void

• Parameters

  • binding: Binding
  • to: Service[]

  Returns void

addEnv

• addEnv(env: Env, to?: Service[]): void

• Parameters

  • env: Env
  • Optionalto: Service[]

  Returns void

addNetwork

• addNetwork(network: Network, to?: Service[]): void

• Parameters

  • network: Network
  • Optionalto: Service[]

  Returns void

addSecret

• addSecret(secret: Secret, to?: Service[]): void

• Parameters

  • secret: Secret
  • Optionalto: Service[]

  Returns void

addService

• addService(service: Service): void

• Parameters

  • service: Service

  Returns void

equal

• equal(other: Compose): boolean

• Parameters

  • other: Compose

  Returns boolean

hash

• hash(): string

• Returns a stable string representation usable as an equality key.

  Previously this used a Node crypto.createHash('sha256') digest, but that broke browser bundles (crypto is Node-only, and the Web Crypto subtle.digest is async). The serialized JSON is sufficient for the equal() use case, which only needs deterministic comparison.

  Returns string

removeBinding

• removeBinding(binding: Binding, from: Service): void

• Parameters

  • binding: Binding
  • from: Service

  Returns void

removeEnv

• removeEnv(env: Env): void

• Parameters

  • env: Env

  Returns void

removeNetwork

• removeNetwork(network: Network): void

• Parameters

  • network: Network

  Returns void

removeSecret

• removeSecret(secret: Secret): void

• Parameters

  • secret: Secret

  Returns void

removeService

• removeService(service: Service): void

• Parameters

  • service: Service

  Returns void

removeVolume

• removeVolume(volume: Volume): void

• Parameters

  • volume: Volume

  Returns void

shallowCopy

• shallowCopy(): Compose

• Returns Compose