DockerCompose overview
Compose engine.
Added in v1.0.0
Table of contents
Errors
DockerComposeError (class)
Signature
export declare class DockerComposeError
Added in v1.0.0
isDockerComposeError
Signature
export declare const isDockerComposeError: (u: unknown) => u is DockerComposeError
Added in v1.0.0
Layers
layerAgnostic
Signature
export declare const layerAgnostic: (
connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, HttpClient.HttpClient | Socket.WebSocketConstructor>
Added in v1.0.0
layerBun
Signature
export declare const layerBun: (
connectionOptions: MobyConnectionOptions
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, never>
Added in v1.0.0
layerDeno
Signature
export declare const layerDeno: (
connectionOptions: MobyConnectionOptions
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, never>
Added in v1.0.0
layerNodeJS
Signature
export declare const layerNodeJS: (
connectionOptions: MobyConnectionOptions
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, never>
Added in v1.0.0
layerProject
Signature
export declare const layerProject: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
tagIdentifier: string
) => {
readonly tag: Context.Tag<DockerComposeProject, DockerComposeProject>
readonly layer: Layer.Layer<DockerComposeProject, E1 | DockerComposeError, DockerCompose>
}
Added in v1.0.0
layerUndici
Signature
export declare const layerUndici: (
connectionOptions: MobyConnectionOptions
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, never>
Added in v1.0.0
layerWeb
Signature
export declare const layerWeb: (
connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
) => Layer.Layer<DockerCompose, SystemsError | ContainersError, never>
Added in v1.0.0
Models
DockerCompose (interface)
Signature
export interface DockerCompose {
readonly [TypeId]: TypeId
readonly build: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly pull: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly up: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly down: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly rm: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly kill: <E1>(
project: Stream.Stream<Uint8Array, E1, never>,
options: {}
) => Effect.Effect<void, E1 | DockerComposeError, never>
readonly forProject: <E1>(
project: Stream.Stream<Uint8Array, E1, never>
) => Effect.Effect<DockerComposeProject, E1 | DockerComposeError, never>
}
Added in v1.0.0
DockerComposeProject (interface)
Signature
export interface DockerComposeProject {
readonly [DockerComposeProjectTypeId]: DockerComposeProjectTypeId
readonly build: (options: {}) => Effect.Effect<void, DockerComposeError, never>
readonly pull: (options: {}) => Effect.Effect<void, DockerComposeError, never>
readonly up: (options: {}) => Effect.Effect<void, DockerComposeError, never>
readonly down: (options: {}) => Effect.Effect<void, DockerComposeError, never>
readonly rm: (options: {}) => Effect.Effect<void, DockerComposeError, never>
readonly kill: (options: {}) => Effect.Effect<void, DockerComposeError, never>
}
Added in v1.0.0
Tags
DockerCompose
Signature
export declare const DockerCompose: Context.Tag<DockerCompose, DockerCompose>
Added in v1.0.0
Type id
DockerComposeProjectTypeId
Signature
export declare const DockerComposeProjectTypeId: typeof DockerComposeProjectTypeId
Added in v1.0.0
DockerComposeProjectTypeId (type alias)
Signature
export type DockerComposeProjectTypeId = typeof DockerComposeProjectTypeId
Added in v1.0.0
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v1.0.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v1.0.0