DindEngine.ts overview
Docker in docker engine.
Since v1.0.0
Exports Grouped by Category
Layers
MakeDindLayerFromPlatformConstructor (type alias)
Signature
type MakeDindLayerFromPlatformConstructor<
PlatformLayerConstructor,
SupportedConnectionOptions,
PlatformLayerConstructorError,
PlatformLayerConstructorContext
> = <
ConnectionOptionsToHost extends SupportedConnectionOptions,
ConnectionOptionsToDind extends SupportedConnectionOptions["_tag"]
>(options: {
exposeDindContainerBy: ConnectionOptionsToDind
connectionOptionsToHost: ConnectionOptionsToHost
dindBaseImage: BlobConstants.RecommendedDindBaseImages
}) => Layer.Layer<
Layer.Layer.Success<DockerEngine.DockerLayer>,
| MobyEndpoints.ImagesError
| MobyEndpoints.SystemsError
| MobyEndpoints.VolumesError
| ParseResult.ParseError
| MobyEndpoints.ContainersError
| PlatformLayerConstructorError
| (ConnectionOptionsToDind extends "socket" ? PlatformError.PlatformError : never),
| PlatformLayerConstructorContext
| (ConnectionOptionsToDind extends "socket" ? Path.Path | FileSystem.FileSystem : never)
>
Since v1.0.0
layerAgnostic
Signature
declare const layerAgnostic: MakeDindLayerFromPlatformConstructor<
(
connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged
) => DockerEngine.DockerLayerWithoutHttpClientOrWebsocketConstructor,
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
HttpClient | WebSocketConstructor
>
Since v1.0.0
layerBun
Signature
declare const layerBun: MakeDindLayerFromPlatformConstructor<
(connectionOptions: MobyConnection.MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined | undefined }
| {
readonly _tag: "ssh"
readonly remoteSocketPath: string
readonly host: string
readonly version?: string | undefined | undefined
readonly port?: number | undefined
readonly forceIPv4?: boolean | undefined
readonly forceIPv6?: boolean | undefined
readonly hostHash?: string | undefined
readonly hostVerifier?:
| (HostVerifier | SyncHostVerifier | HostFingerprintVerifier | SyncHostFingerprintVerifier)
| undefined
readonly username?: string | undefined
readonly password?: string | undefined
readonly agent?: (BaseAgent | string) | undefined
readonly privateKey?: (Buffer | string) | undefined
readonly passphrase?: (Buffer | string) | undefined
readonly localHostname?: string | undefined
readonly localUsername?: string | undefined
readonly tryKeyboard?: boolean | undefined
readonly keepaliveInterval?: number | undefined
readonly keepaliveCountMax?: number | undefined
readonly readyTimeout?: number | undefined
readonly strictVendor?: boolean | undefined
readonly sock?: Stream.Readable | undefined
readonly agentForward?: boolean | undefined
readonly algorithms?: Algorithms | undefined
readonly debug?: DebugFunction | undefined
readonly authHandler?: (AuthenticationType[] | AuthHandlerMiddleware | AuthMethod[]) | undefined
readonly localAddress?: string | undefined
readonly localPort?: number | undefined
readonly timeout?: number | undefined
readonly ident?: (Buffer | string) | undefined
}
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0
layerDeno
Signature
declare const layerDeno: MakeDindLayerFromPlatformConstructor<
(connectionOptions: MobyConnection.MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined | undefined }
| {
readonly _tag: "ssh"
readonly remoteSocketPath: string
readonly host: string
readonly version?: string | undefined | undefined
readonly port?: number | undefined
readonly forceIPv4?: boolean | undefined
readonly forceIPv6?: boolean | undefined
readonly hostHash?: string | undefined
readonly hostVerifier?:
| (HostVerifier | SyncHostVerifier | HostFingerprintVerifier | SyncHostFingerprintVerifier)
| undefined
readonly username?: string | undefined
readonly password?: string | undefined
readonly agent?: (BaseAgent | string) | undefined
readonly privateKey?: (Buffer | string) | undefined
readonly passphrase?: (Buffer | string) | undefined
readonly localHostname?: string | undefined
readonly localUsername?: string | undefined
readonly tryKeyboard?: boolean | undefined
readonly keepaliveInterval?: number | undefined
readonly keepaliveCountMax?: number | undefined
readonly readyTimeout?: number | undefined
readonly strictVendor?: boolean | undefined
readonly sock?: Stream.Readable | undefined
readonly agentForward?: boolean | undefined
readonly algorithms?: Algorithms | undefined
readonly debug?: DebugFunction | undefined
readonly authHandler?: (AuthenticationType[] | AuthHandlerMiddleware | AuthMethod[]) | undefined
readonly localAddress?: string | undefined
readonly localPort?: number | undefined
readonly timeout?: number | undefined
readonly ident?: (Buffer | string) | undefined
}
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0
layerFetch
Signature
declare const layerFetch: MakeDindLayerFromPlatformConstructor<
(
connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged
) => DockerEngine.DockerLayer,
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0
layerNodeJS
Signature
declare const layerNodeJS: MakeDindLayerFromPlatformConstructor<
(connectionOptions: MobyConnection.MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined | undefined }
| {
readonly _tag: "ssh"
readonly remoteSocketPath: string
readonly host: string
readonly version?: string | undefined | undefined
readonly port?: number | undefined
readonly forceIPv4?: boolean | undefined
readonly forceIPv6?: boolean | undefined
readonly hostHash?: string | undefined
readonly hostVerifier?:
| (HostVerifier | SyncHostVerifier | HostFingerprintVerifier | SyncHostFingerprintVerifier)
| undefined
readonly username?: string | undefined
readonly password?: string | undefined
readonly agent?: (BaseAgent | string) | undefined
readonly privateKey?: (Buffer | string) | undefined
readonly passphrase?: (Buffer | string) | undefined
readonly localHostname?: string | undefined
readonly localUsername?: string | undefined
readonly tryKeyboard?: boolean | undefined
readonly keepaliveInterval?: number | undefined
readonly keepaliveCountMax?: number | undefined
readonly readyTimeout?: number | undefined
readonly strictVendor?: boolean | undefined
readonly sock?: Stream.Readable | undefined
readonly agentForward?: boolean | undefined
readonly algorithms?: Algorithms | undefined
readonly debug?: DebugFunction | undefined
readonly authHandler?: (AuthenticationType[] | AuthHandlerMiddleware | AuthMethod[]) | undefined
readonly localAddress?: string | undefined
readonly localPort?: number | undefined
readonly timeout?: number | undefined
readonly ident?: (Buffer | string) | undefined
}
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0
layerUndici
Signature
declare const layerUndici: MakeDindLayerFromPlatformConstructor<
(connectionOptions: MobyConnection.MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string; readonly version?: string | undefined | undefined }
| {
readonly _tag: "ssh"
readonly remoteSocketPath: string
readonly host: string
readonly version?: string | undefined | undefined
readonly port?: number | undefined
readonly forceIPv4?: boolean | undefined
readonly forceIPv6?: boolean | undefined
readonly hostHash?: string | undefined
readonly hostVerifier?:
| (HostVerifier | SyncHostVerifier | HostFingerprintVerifier | SyncHostFingerprintVerifier)
| undefined
readonly username?: string | undefined
readonly password?: string | undefined
readonly agent?: (BaseAgent | string) | undefined
readonly privateKey?: (Buffer | string) | undefined
readonly passphrase?: (Buffer | string) | undefined
readonly localHostname?: string | undefined
readonly localUsername?: string | undefined
readonly tryKeyboard?: boolean | undefined
readonly keepaliveInterval?: number | undefined
readonly keepaliveCountMax?: number | undefined
readonly readyTimeout?: number | undefined
readonly strictVendor?: boolean | undefined
readonly sock?: Stream.Readable | undefined
readonly agentForward?: boolean | undefined
readonly algorithms?: Algorithms | undefined
readonly debug?: DebugFunction | undefined
readonly authHandler?: (AuthenticationType[] | AuthHandlerMiddleware | AuthMethod[]) | undefined
readonly localAddress?: string | undefined
readonly localPort?: number | undefined
readonly timeout?: number | undefined
readonly ident?: (Buffer | string) | undefined
}
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0
layerWeb
Signature
declare const layerWeb: MakeDindLayerFromPlatformConstructor<
(
connectionOptions: MobyConnection.HttpConnectionOptionsTagged | MobyConnection.HttpsConnectionOptionsTagged
) => DockerEngine.DockerLayer,
| {
readonly _tag: "http"
readonly host: string
readonly port: number
readonly path?: string | undefined | undefined
readonly version?: string | undefined | undefined
}
| {
readonly _tag: "https"
readonly host: string
readonly port: number
readonly version?: string | undefined | undefined
readonly path?: string | undefined | undefined
readonly cert?: string | undefined | undefined
readonly ca?: string | undefined | undefined
readonly key?: string | undefined | undefined
readonly passphrase?: string | undefined | undefined
},
never,
never
>
Since v1.0.0