AxDockerSession
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L56
Constructors
Constructor
new AxDockerSession(apiUrl: string): AxDockerSession;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L60
Parameters
Parameter | Type | Default value |
---|---|---|
apiUrl | string | 'http://localhost:2375' |
Returns
AxDockerSession
Methods
connectToContainer()
connectToContainer(containerId: string): Promise<void>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L186
Parameters
Parameter | Type |
---|---|
containerId | string |
Returns
Promise
<void
>
createContainer()
createContainer(__namedParameters: Readonly<{
doNotPullImage?: boolean;
imageName: string;
tag?: string;
volumes?: object[];
}>): Promise<{
Id: string;
}>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L80
Parameters
Parameter | Type |
---|---|
__namedParameters | Readonly <{ doNotPullImage? : boolean ; imageName : string ; tag? : string ; volumes? : object []; }> |
Returns
Promise
<{
Id
: string
;
}>
executeCommand()
executeCommand(command: string): Promise<string>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L274
Parameters
Parameter | Type |
---|---|
command | string |
Returns
Promise
<string
>
findOrCreateContainer()
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/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/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()
getContainerLogs(): Promise<string>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L263
Returns
Promise
<string
>
listContainers()
listContainers(all: boolean): Promise<AxDockerContainer[]>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L256
Parameters
Parameter | Type | Default value |
---|---|---|
all | boolean | false |
Returns
Promise
<AxDockerContainer
[]>
pullImage()
pullImage(imageName: string): Promise<void>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L64
Parameters
Parameter | Type |
---|---|
imageName | string |
Returns
Promise
<void
>
startContainer()
startContainer(): Promise<void>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L169
Returns
Promise
<void
>
stopContainers()
stopContainers(__namedParameters: Readonly<{
remove?: boolean;
tag?: string;
timeout?: number;
}>): Promise<object[]>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L198
Parameters
Parameter | Type |
---|---|
__namedParameters | Readonly <{ remove? : boolean ; tag? : string ; timeout? : number ; }> |
Returns
Promise
<object
[]>
toFunction()
toFunction(): AxFunction;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/funcs/docker.ts#L373