AxDockerSession

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L56

Constructors

Constructor

TypeScript

new AxDockerSession(apiUrl: string): AxDockerSession;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L60

Parameters

Parameter	Type	Default value
`apiUrl`	`string`	`'http://localhost:2375'`

Returns

AxDockerSession

Methods

connectToContainer()

TypeScript

connectToContainer(containerId: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L186

Parameters

Parameter	Type
`containerId`	`string`

Returns

Promise<void>

createContainer()

TypeScript

createContainer(__namedParameters: Readonly<{
  doNotPullImage?: boolean;
  imageName: string;
  tag?: string;
  volumes?: object[];
}>): Promise<{
  Id: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L80

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `doNotPullImage?`: `boolean`; `imageName`: `string`; `tag?`: `string`; `volumes?`: `object`[]; }>

Returns

Promise<{ Id: string; }>

executeCommand()

TypeScript

executeCommand(command: string): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L274

Parameters

Parameter	Type
`command`	`string`

Returns

Promise<string>

findOrCreateContainer()

TypeScript

findOrCreateContainer(__namedParameters: Readonly<{
  doNotPullImage?: boolean;
  imageName: string;
  tag: string;
  volumes?: object[];
}>): Promise<{
  Id: string;
  isNew: boolean;
}>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L128

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `doNotPullImage?`: `boolean`; `imageName`: `string`; `tag`: `string`; `volumes?`: `object`[]; }>

Returns

Promise<{ Id: string; isNew: boolean; }>

getContainerLogs()

TypeScript

getContainerLogs(): Promise<string>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L263

Returns

Promise<string>

listContainers()

TypeScript

listContainers(all: boolean): Promise<AxDockerContainer[]>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L256

Parameters

Parameter	Type	Default value
`all`	`boolean`	`false`

Returns

Promise<AxDockerContainer[]>

pullImage()

TypeScript

pullImage(imageName: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L64

Parameters

Parameter	Type
`imageName`	`string`

Returns

Promise<void>

startContainer()

TypeScript

startContainer(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L169

Returns

Promise<void>

stopContainers()

TypeScript

stopContainers(__namedParameters: Readonly<{
  remove?: boolean;
  tag?: string;
  timeout?: number;
}>): Promise<object[]>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L198

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<{ `remove?`: `boolean`; `tag?`: `string`; `timeout?`: `number`; }>

Returns

Promise<object[]>

toFunction()

TypeScript

toFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/funcs/docker.ts#L371

Returns

AxFunction