Class Compose

The main class of this package. Can be used as a state manager under a library like zustand.

Hierarchy (View Summary)

Serializable
- Compose

Index

Constructors

Properties

envs name? networks secrets services version? volumes

Methods

addBinding addEnv addNetwork addSecret addService equal hash removeBinding removeEnv removeNetwork removeSecret removeService removeVolume shallowCopy toJSON

Constructors

constructor

new Compose(options?: Partial<Compose>): Compose
Parameters
- Optionaloptions: Partial<Compose>
Returns Compose
Overrides Serializable.constructor
- Defined in src/compose/compose.ts:29

Properties

envs

envs: SuperSet<Env>

`Optional`name

name?: string

networks

networks: SuperSet<Network>

secrets

secrets: SuperSet<Secret>

services

services: SuperSet<Service>

`Optional`version

version?: ComposeVersion

volumes

volumes: SuperSet<Volume>

Methods

addBinding

addBinding(binding: Binding, to: Service[]): void
Parameters
- binding: Binding
- to: Service[]
Returns void
- Defined in src/compose/compose.ts:70

addEnv

addEnv(env: Env, to?: Service[]): void
Parameters
- env: Env
- Optionalto: Service[]
Returns void
- Defined in src/compose/compose.ts:104

addNetwork

addNetwork(network: Network, to?: Service[]): void
Parameters
- network: Network
- Optionalto: Service[]
Returns void
- Defined in src/compose/compose.ts:51

addSecret

addSecret(secret: Secret, to?: Service[]): void
Parameters
- secret: Secret
- Optionalto: Service[]
Returns void
- Defined in src/compose/compose.ts:94

addService

addService(service: Service): void
Parameters
- service: Service
Returns void
- Defined in src/compose/compose.ts:61

equal

equal(other: Compose): boolean
Parameters
- other: Compose
Returns boolean
- Defined in src/compose/compose.ts:131

hash

hash(): string
Returns string
- Defined in src/compose/compose.ts:127

removeBinding

removeBinding(binding: Binding, from: Service): void
Parameters
- binding: Binding
- from: Service
Returns void
- Defined in src/compose/compose.ts:79

removeEnv

removeEnv(env: Env): void
Parameters
- env: Env
Returns void
- Defined in src/compose/compose.ts:117

removeNetwork

removeNetwork(network: Network): void
Parameters
- network: Network
Returns void
- Defined in src/compose/compose.ts:56

removeSecret

removeSecret(secret: Secret): void
Parameters
- secret: Secret
Returns void
- Defined in src/compose/compose.ts:99

removeService

removeService(service: Service): void
Parameters
- service: Service
Returns void
- Defined in src/compose/compose.ts:65

removeVolume

removeVolume(volume: Volume): void
Parameters
- volume: Volume
Returns void
- Defined in src/compose/compose.ts:83

shallowCopy

shallowCopy(): Compose
Returns Compose
- Defined in src/compose/compose.ts:40

toJSON

toJSON(): Compose
Returns Compose
Inherited from Serializable.toJSON
- Defined in src/commons/serializable.ts:9