Variable: buildDockerSocketConnectionOptions

const buildDockerSocketConnectionOptions: ComponentOptionsBuilder<IDockerConnectionOptions>

Build the component options of a Docker connected to the Unix socket of a daemon (or its named pipe on Windows), to register it in the components of an application. The options are validated when the component is created, not here.

Param

options

The path of the socket (socketPath), with the timeout and the API version. Without socketPath, the Docker of the environment is used, with the other options applied over it.

Returns

The component options ({class: Docker, ...options}).

Example

import {Application} from 'lakutata'
import {buildDockerSocketConnectionOptions} from 'lakutata/com/docker'

Application.run(() => ({
    id: 'docker.app',
    name: 'Docker',
    components: {
        docker: buildDockerSocketConnectionOptions({socketPath: '/var/run/docker.sock', timeout: 60000})
    }
}))