Skip to content

AxDockerSession

Class: AxDockerSession

Constructors

new AxDockerSession()

new AxDockerSession(apiUrl): AxDockerSession

Parameters

apiUrl: string = 'http://localhost:2375'

Returns

AxDockerSession

Defined in

src/ax/funcs/docker.ts:60

Methods

connectToContainer()

connectToContainer(containerId): Promise<void>

Parameters

containerId: string

Returns

Promise<void>

Defined in

src/ax/funcs/docker.ts:186


createContainer()

createContainer(__namedParameters): Promise<object>

Parameters

__namedParameters: Readonly<object>

Returns

Promise<object>

Id

Id: string

Defined in

src/ax/funcs/docker.ts:80


executeCommand()

executeCommand(command): Promise<string>

Parameters

command: string

Returns

Promise<string>

Defined in

src/ax/funcs/docker.ts:274


findOrCreateContainer()

findOrCreateContainer(__namedParameters): Promise<object>

Parameters

__namedParameters: Readonly<object>

Returns

Promise<object>

Id

Id: string

isNew

isNew: boolean

Defined in

src/ax/funcs/docker.ts:128


getContainerLogs()

getContainerLogs(): Promise<string>

Returns

Promise<string>

Defined in

src/ax/funcs/docker.ts:263


listContainers()

listContainers(all): Promise<AxDockerContainer[]>

Parameters

all: boolean = false

Returns

Promise<AxDockerContainer[]>

Defined in

src/ax/funcs/docker.ts:256


pullImage()

pullImage(imageName): Promise<void>

Parameters

imageName: string

Returns

Promise<void>

Defined in

src/ax/funcs/docker.ts:64


startContainer()

startContainer(): Promise<void>

Returns

Promise<void>

Defined in

src/ax/funcs/docker.ts:169


stopContainers()

stopContainers(__namedParameters): Promise<object[]>

Parameters

__namedParameters: Readonly<object>

Returns

Promise<object[]>

Defined in

src/ax/funcs/docker.ts:198


toFunction()

toFunction(): AxFunction

Returns

AxFunction

Defined in

src/ax/funcs/docker.ts:373