Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/api/classes/DockerRunner.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

[light-runner](../index.md) / DockerRunner

# Class: DockerRunner

Defined in: [src/DockerRunner.ts:36](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L36)
Defined in: [src/DockerRunner.ts:36](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L36)

## Constructors

Expand All @@ -16,7 +16,7 @@ Defined in: [src/DockerRunner.ts:36](https://github.com/enixCode/light-runner/bl
new DockerRunner(options?): DockerRunner;
```

Defined in: [src/DockerRunner.ts:39](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L39)
Defined in: [src/DockerRunner.ts:39](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L39)

#### Parameters

Expand All @@ -36,7 +36,7 @@ Defined in: [src/DockerRunner.ts:39](https://github.com/enixCode/light-runner/bl
run(request): Execution;
```

Defined in: [src/DockerRunner.ts:49](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L49)
Defined in: [src/DockerRunner.ts:49](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L49)

#### Parameters

Expand All @@ -56,7 +56,7 @@ Defined in: [src/DockerRunner.ts:49](https://github.com/enixCode/light-runner/bl
static attach(id): Execution | null;
```

Defined in: [src/DockerRunner.ts:252](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L252)
Defined in: [src/DockerRunner.ts:255](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L255)

#### Parameters

Expand All @@ -76,7 +76,7 @@ Defined in: [src/DockerRunner.ts:252](https://github.com/enixCode/light-runner/b
static cleanupOrphanStates(): Promise<number>;
```

Defined in: [src/DockerRunner.ts:345](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L345)
Defined in: [src/DockerRunner.ts:348](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L348)

#### Returns

Expand All @@ -90,7 +90,7 @@ Defined in: [src/DockerRunner.ts:345](https://github.com/enixCode/light-runner/b
static cleanupOrphanVolumes(): Promise<number>;
```

Defined in: [src/DockerRunner.ts:243](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L243)
Defined in: [src/DockerRunner.ts:246](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L246)

#### Returns

Expand All @@ -104,7 +104,7 @@ Defined in: [src/DockerRunner.ts:243](https://github.com/enixCode/light-runner/b
static isAvailable(): Promise<boolean>;
```

Defined in: [src/DockerRunner.ts:234](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L234)
Defined in: [src/DockerRunner.ts:237](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L237)

#### Returns

Expand All @@ -118,7 +118,7 @@ Defined in: [src/DockerRunner.ts:234](https://github.com/enixCode/light-runner/b
static list(): RunState[];
```

Defined in: [src/DockerRunner.ts:335](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L335)
Defined in: [src/DockerRunner.ts:338](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L338)

#### Returns

Expand All @@ -135,7 +135,7 @@ static reapOrphans(): Promise<{
}>;
```

Defined in: [src/DockerRunner.ts:367](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/DockerRunner.ts#L367)
Defined in: [src/DockerRunner.ts:370](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L370)

#### Returns

Expand Down
20 changes: 10 additions & 10 deletions docs/api/classes/Execution.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

[light-runner](../index.md) / Execution

# Class: Execution

Defined in: [src/Execution.ts:17](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L17)
Defined in: [src/Execution.ts:17](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L17)

## Constructors

Expand All @@ -19,7 +19,7 @@ new Execution(
onCancel): Execution;
```

Defined in: [src/Execution.ts:22](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L22)
Defined in: [src/Execution.ts:22](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L22)

#### Parameters

Expand Down Expand Up @@ -47,7 +47,7 @@ Defined in: [src/Execution.ts:22](https://github.com/enixCode/light-runner/blob/
readonly id: string;
```

Defined in: [src/Execution.ts:18](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L18)
Defined in: [src/Execution.ts:18](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L18)

***

Expand All @@ -57,7 +57,7 @@ Defined in: [src/Execution.ts:18](https://github.com/enixCode/light-runner/blob/
readonly result: Promise<RunResult>;
```

Defined in: [src/Execution.ts:19](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L19)
Defined in: [src/Execution.ts:19](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L19)

## Accessors

Expand All @@ -69,7 +69,7 @@ Defined in: [src/Execution.ts:19](https://github.com/enixCode/light-runner/blob/
get cancelled(): boolean;
```

Defined in: [src/Execution.ts:45](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L45)
Defined in: [src/Execution.ts:45](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L45)

##### Returns

Expand All @@ -83,7 +83,7 @@ Defined in: [src/Execution.ts:45](https://github.com/enixCode/light-runner/blob/
cancel(): void;
```

Defined in: [src/Execution.ts:36](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L36)
Defined in: [src/Execution.ts:36](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L36)

#### Returns

Expand All @@ -97,7 +97,7 @@ Defined in: [src/Execution.ts:36](https://github.com/enixCode/light-runner/blob/
pause(): Promise<void>;
```

Defined in: [src/Execution.ts:92](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L92)
Defined in: [src/Execution.ts:92](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L92)

#### Returns

Expand All @@ -111,7 +111,7 @@ Defined in: [src/Execution.ts:92](https://github.com/enixCode/light-runner/blob/
resume(): Promise<void>;
```

Defined in: [src/Execution.ts:100](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L100)
Defined in: [src/Execution.ts:100](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L100)

#### Returns

Expand All @@ -125,7 +125,7 @@ Defined in: [src/Execution.ts:100](https://github.com/enixCode/light-runner/blob
stop(options?): Promise<void>;
```

Defined in: [src/Execution.ts:54](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/Execution.ts#L54)
Defined in: [src/Execution.ts:54](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L54)

#### Parameters

Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/LightRunnerError.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

[light-runner](../index.md) / LightRunnerError

# Class: LightRunnerError

Defined in: [src/errors.ts:22](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L22)
Defined in: [src/errors.ts:22](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L22)

## Extends

Expand All @@ -20,7 +20,7 @@ Defined in: [src/errors.ts:22](https://github.com/enixCode/light-runner/blob/1d6
new LightRunnerError(opts): LightRunnerError;
```

Defined in: [src/errors.ts:27](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L27)
Defined in: [src/errors.ts:27](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L27)

#### Parameters

Expand Down Expand Up @@ -62,7 +62,7 @@ Error.cause
readonly code: LightRunnerErrorCode;
```

Defined in: [src/errors.ts:23](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L23)
Defined in: [src/errors.ts:23](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L23)

***

Expand All @@ -72,7 +72,7 @@ Defined in: [src/errors.ts:23](https://github.com/enixCode/light-runner/blob/1d6
readonly optional containerId?: string;
```

Defined in: [src/errors.ts:25](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L25)
Defined in: [src/errors.ts:25](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L25)

***

Expand All @@ -82,7 +82,7 @@ Defined in: [src/errors.ts:25](https://github.com/enixCode/light-runner/blob/1d6
readonly optional dockerOp?: string;
```

Defined in: [src/errors.ts:24](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L24)
Defined in: [src/errors.ts:24](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L24)

***

Expand Down Expand Up @@ -172,7 +172,7 @@ toJSON(): {
};
```

Defined in: [src/errors.ts:35](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/errors.ts#L35)
Defined in: [src/errors.ts:35](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L35)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/api/functions/listStates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

Expand All @@ -10,7 +10,7 @@
function listStates(): RunState[];
```

Defined in: [src/state.ts:56](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/state.ts#L56)
Defined in: [src/state.ts:56](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/state.ts#L56)

## Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/api/functions/readState.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

Expand All @@ -10,7 +10,7 @@
function readState(id): RunState | null;
```

Defined in: [src/state.ts:46](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/state.ts#L46)
Defined in: [src/state.ts:46](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/state.ts#L46)

## Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
**light-runner v0.10.0**
**light-runner v0.10.1**

***

# light-runner v0.10.0
# light-runner v0.10.1

## Classes

Expand Down
14 changes: 7 additions & 7 deletions docs/api/interfaces/ExtractResult.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

[light-runner](../index.md) / ExtractResult

# Interface: ExtractResult

Defined in: [src/types.ts:26](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L26)
Defined in: [src/types.ts:26](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L26)

## Properties

Expand All @@ -16,7 +16,7 @@ Defined in: [src/types.ts:26](https://github.com/enixCode/light-runner/blob/1d60
optional bytes?: number;
```

Defined in: [src/types.ts:31](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L31)
Defined in: [src/types.ts:31](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L31)

***

Expand All @@ -26,7 +26,7 @@ Defined in: [src/types.ts:31](https://github.com/enixCode/light-runner/blob/1d60
optional error?: string;
```

Defined in: [src/types.ts:30](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L30)
Defined in: [src/types.ts:30](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L30)

***

Expand All @@ -36,7 +36,7 @@ Defined in: [src/types.ts:30](https://github.com/enixCode/light-runner/blob/1d60
from: string;
```

Defined in: [src/types.ts:27](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L27)
Defined in: [src/types.ts:27](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L27)

***

Expand All @@ -46,7 +46,7 @@ Defined in: [src/types.ts:27](https://github.com/enixCode/light-runner/blob/1d60
status: "ok" | "missing" | "error";
```

Defined in: [src/types.ts:29](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L29)
Defined in: [src/types.ts:29](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L29)

***

Expand All @@ -56,4 +56,4 @@ Defined in: [src/types.ts:29](https://github.com/enixCode/light-runner/blob/1d60
to: string;
```

Defined in: [src/types.ts:28](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L28)
Defined in: [src/types.ts:28](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L28)
8 changes: 4 additions & 4 deletions docs/api/interfaces/ExtractSpec.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[**light-runner v0.10.0**](../index.md)
[**light-runner v0.10.1**](../index.md)

***

[light-runner](../index.md) / ExtractSpec

# Interface: ExtractSpec

Defined in: [src/types.ts:11](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L11)
Defined in: [src/types.ts:11](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L11)

## Properties

Expand All @@ -16,7 +16,7 @@ Defined in: [src/types.ts:11](https://github.com/enixCode/light-runner/blob/1d60
from: string;
```

Defined in: [src/types.ts:16](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L16)
Defined in: [src/types.ts:16](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L16)

***

Expand All @@ -26,4 +26,4 @@ Defined in: [src/types.ts:16](https://github.com/enixCode/light-runner/blob/1d60
to: string;
```

Defined in: [src/types.ts:23](https://github.com/enixCode/light-runner/blob/1d600653d4731c2d3f44bd5a293b40da3c37d55c/src/types.ts#L23)
Defined in: [src/types.ts:23](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L23)
Loading
Loading