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
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ jobs:
build-and-unit:
name: Build + unit tests - Node ${{ matrix.node-version }}
runs-on: ubuntu-latest
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
Expand All @@ -36,6 +37,7 @@ jobs:
e2e:
name: End-to-end tests (Docker)
runs-on: ubuntu-latest
timeout-minutes: 15
needs: build-and-unit

steps:
Expand Down
18 changes: 9 additions & 9 deletions docs/api/classes/DockerRunner.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: DockerRunner

Defined in: [src/DockerRunner.ts:36](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L36)
Defined in: [src/DockerRunner.ts:36](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L39)
Defined in: [src/DockerRunner.ts:39](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L49)
Defined in: [src/DockerRunner.ts:49](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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:255](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L255)
Defined in: [src/DockerRunner.ts:253](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L253)

#### Parameters

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

Defined in: [src/DockerRunner.ts:348](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L348)
Defined in: [src/DockerRunner.ts:346](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L346)

#### Returns

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

Defined in: [src/DockerRunner.ts:246](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L246)
Defined in: [src/DockerRunner.ts:244](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L244)

#### Returns

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

Defined in: [src/DockerRunner.ts:237](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L237)
Defined in: [src/DockerRunner.ts:235](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L235)

#### Returns

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

Defined in: [src/DockerRunner.ts:338](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L338)
Defined in: [src/DockerRunner.ts:336](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L336)

#### Returns

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

Defined in: [src/DockerRunner.ts:370](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/DockerRunner.ts#L370)
Defined in: [src/DockerRunner.ts:368](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/DockerRunner.ts#L368)

#### Returns

Expand Down
18 changes: 9 additions & 9 deletions docs/api/classes/Execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: Execution

Defined in: [src/Execution.ts:17](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L17)
Defined in: [src/Execution.ts:17](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L22)
Defined in: [src/Execution.ts:22](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L18)
Defined in: [src/Execution.ts:18](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L19)
Defined in: [src/Execution.ts:19](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L45)
Defined in: [src/Execution.ts:45](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L36)
Defined in: [src/Execution.ts:36](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L92)
Defined in: [src/Execution.ts:92](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L100)
Defined in: [src/Execution.ts:100](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/Execution.ts#L54)
Defined in: [src/Execution.ts:54](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/Execution.ts#L54)

#### Parameters

Expand Down
12 changes: 6 additions & 6 deletions docs/api/classes/LightRunnerError.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: LightRunnerError

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

## Extends

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

Defined in: [src/errors.ts:27](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L27)
Defined in: [src/errors.ts:27](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L23)
Defined in: [src/errors.ts:23](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/errors.ts#L23)

***

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

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

***

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

Defined in: [src/errors.ts:24](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L24)
Defined in: [src/errors.ts:24](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/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/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/errors.ts#L35)
Defined in: [src/errors.ts:35](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/errors.ts#L35)

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/api/functions/listStates.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
function listStates(): RunState[];
```

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

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/api/functions/readState.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
function readState(id): RunState | null;
```

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

## Parameters

Expand Down
12 changes: 6 additions & 6 deletions docs/api/interfaces/ExtractResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: ExtractResult

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

## Properties

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

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

***

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

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

***

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

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

***

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

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

***

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

Defined in: [src/types.ts:28](https://github.com/enixCode/light-runner/blob/eaf4c39bcc8324bb37357dbfce55a3a3206548d5/src/types.ts#L28)
Defined in: [src/types.ts:28](https://github.com/enixCode/light-runner/blob/31b389b1d15a9728ad727b30ba3cbee438426ff9/src/types.ts#L28)
6 changes: 3 additions & 3 deletions docs/api/interfaces/ExtractSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: ExtractSpec

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

## Properties

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

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

***

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

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