Skip to content

Commit 8b9fce7

Browse files
author
a-tylenda
committed
Add typedocs
1 parent f75f0e6 commit 8b9fce7

File tree

80 files changed

+9193
-10110
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+9193
-10110
lines changed

‎docs/adapters/classes/DockerInstanceAdapter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Finds free port for every port requested in Sequence configuration and returns m
229229
| :------ | :------ | :------ | :------ |
230230
| `declaredPorts` | `string`[] | `undefined` | Ports declared in sequence config. |
231231
| `containerConfig` | `ContainerConfiguration` & `ContainerConfigurationWithExposedPorts` | `undefined` | Container configuration extended with configuration for ports exposing. |
232-
| `exposed` | `boolean` | `false` | - |
232+
| `exposed?` | `boolean` | `false` | Defines configuration output type. Exposed ports when true or port bindings. |
233233

234234
#### Returns
235235

‎docs/adapters/classes/DockerSequenceAdapter.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Created volume.
7070

7171
#### Defined in
7272

73-
[docker-sequence-adapter.ts:204](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L204)
73+
[docker-sequence-adapter.ts:209](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L209)
7474

7575
___
7676

@@ -98,7 +98,7 @@ ___
9898

9999
### identify
100100

101-
▸ **identify**(`stream`, `id`): `Promise`<`SequenceConfig`\>
101+
▸ **identify**(`stream`, `id`, `override?`): `Promise`<`SequenceConfig`\>
102102

103103
Unpacks and identifies sequence in Docker volume.
104104
This is the main adapter method creating new Docker volume and starting Prerunner
@@ -107,10 +107,11 @@ When Prerunner finishes, it will return JSON with sequence information.
107107

108108
#### Parameters
109109

110-
| Name | Type | Description |
111-
| :------ | :------ | :------ |
112-
| `stream` | `Readable` | Stream containing sequence to be identified. |
113-
| `id` | `string` | Id for the new docker volume where sequence will be stored. |
110+
| Name | Type | Default value | Description |
111+
| :------ | :------ | :------ | :------ |
112+
| `stream` | `Readable` | `undefined` | Stream containing sequence to be identified. |
113+
| `id` | `string` | `undefined` | Id for the new docker volume where sequence will be stored. |
114+
| `override` | `boolean` | `false` | Removes previous sequence |
114115

115116
#### Returns
116117

@@ -124,7 +125,7 @@ ISequenceAdapter.identify
124125

125126
#### Defined in
126127

127-
[docker-sequence-adapter.ts:136](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L136)
128+
[docker-sequence-adapter.ts:137](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L137)
128129

129130
___
130131

@@ -216,7 +217,7 @@ Promise resolving to sequence configuration.
216217

217218
#### Defined in
218219

219-
[docker-sequence-adapter.ts:222](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L222)
220+
[docker-sequence-adapter.ts:228](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L228)
220221

221222
___
222223

@@ -242,7 +243,7 @@ ISequenceAdapter.remove
242243

243244
#### Defined in
244245

245-
[docker-sequence-adapter.ts:274](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L274)
246+
[docker-sequence-adapter.ts:283](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/docker-sequence-adapter.ts#L283)
246247

247248
## Properties
248249

‎docs/adapters/classes/DockerodeDockerHelper.md‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Promise resolving with created container id.
124124

125125
#### Implementation of
126126

127-
[IDockerHelper](../interfaces/IDockerHelper.md).[createContainer](../interfaces/IDockerHelper.md#createcontainer)
127+
IDockerHelper.createContainer
128128

129129
#### Defined in
130130

@@ -176,7 +176,7 @@ Volume name.
176176

177177
#### Implementation of
178178

179-
[IDockerHelper](../interfaces/IDockerHelper.md).[createVolume](../interfaces/IDockerHelper.md#createvolume)
179+
IDockerHelper.createVolume
180180

181181
#### Defined in
182182

@@ -256,9 +256,11 @@ Lists existing volumes
256256

257257
`Promise`<`string`[]\>
258258

259+
List of existing volumes
260+
259261
#### Implementation of
260262

261-
[IDockerHelper](../interfaces/IDockerHelper.md).[listVolumes](../interfaces/IDockerHelper.md#listvolumes)
263+
IDockerHelper.listVolumes
262264

263265
#### Defined in
264266

@@ -274,10 +276,10 @@ Fetches the image from repo
274276

275277
#### Parameters
276278

277-
| Name | Type | Default value |
278-
| :------ | :------ | :------ |
279-
| `name` | `string` | `undefined` |
280-
| `fetchOnlyIfNotExists` | `boolean` | `true` |
279+
| Name | Type | Default value | Description |
280+
| :------ | :------ | :------ | :------ |
281+
| `name` | `string` | `undefined` | the name of the image, eg. ubuntu:latest |
282+
| `fetchOnlyIfNotExists` | `boolean` | `true` | fetch only if not exists (defaults to true) |
281283

282284
#### Returns
283285

@@ -313,7 +315,7 @@ Promise which resolves when container has been removed.
313315

314316
#### Implementation of
315317

316-
[IDockerHelper](../interfaces/IDockerHelper.md).[removeContainer](../interfaces/IDockerHelper.md#removecontainer)
318+
IDockerHelper.removeContainer
317319

318320
#### Defined in
319321

@@ -341,7 +343,7 @@ Promise which resolves when volume has been removed.
341343

342344
#### Implementation of
343345

344-
[IDockerHelper](../interfaces/IDockerHelper.md).[removeVolume](../interfaces/IDockerHelper.md#removevolume)
346+
IDockerHelper.removeVolume
345347

346348
#### Defined in
347349

@@ -355,6 +357,8 @@ ___
355357

356358
Starts container.
357359

360+
**`See`**
361+
358362
#### Parameters
359363

360364
| Name | Type | Description |
@@ -365,11 +369,9 @@ Starts container.
365369

366370
`Promise`<[`DockerAdapterRunResponse`](../modules.md#dockeradapterrunresponse)\>
367371

368-
@see {DockerAdapterRunResponse}
369-
370372
#### Implementation of
371373

372-
[IDockerHelper](../interfaces/IDockerHelper.md).[run](../interfaces/IDockerHelper.md#run)
374+
IDockerHelper.run
373375

374376
#### Defined in
375377

@@ -397,7 +399,7 @@ Promise resolving when container has been started.
397399

398400
#### Implementation of
399401

400-
[IDockerHelper](../interfaces/IDockerHelper.md).[startContainer](../interfaces/IDockerHelper.md#startcontainer)
402+
IDockerHelper.startContainer
401403

402404
#### Defined in
403405

@@ -425,7 +427,7 @@ Promise which resolves with container statistics.
425427

426428
#### Implementation of
427429

428-
[IDockerHelper](../interfaces/IDockerHelper.md).[stats](../interfaces/IDockerHelper.md#stats)
430+
IDockerHelper.stats
429431

430432
#### Defined in
431433

@@ -453,7 +455,7 @@ Promise which resolves when the container has been stopped.
453455

454456
#### Implementation of
455457

456-
[IDockerHelper](../interfaces/IDockerHelper.md).[stopContainer](../interfaces/IDockerHelper.md#stopcontainer)
458+
IDockerHelper.stopContainer
457459

458460
#### Defined in
459461

@@ -481,7 +483,7 @@ Translated volumes configuration.
481483

482484
#### Implementation of
483485

484-
[IDockerHelper](../interfaces/IDockerHelper.md).[translateVolumesConfig](../interfaces/IDockerHelper.md#translatevolumesconfig)
486+
IDockerHelper.translateVolumesConfig
485487

486488
#### Defined in
487489

@@ -495,12 +497,14 @@ ___
495497

496498
Waits for container status change.
497499

500+
**`See`**
501+
498502
#### Parameters
499503

500504
| Name | Type | Description |
501505
| :------ | :------ | :------ |
502506
| `container` | `string` | Container id. |
503-
| `options` | [`DockerAdapterWaitOptions`](../modules.md#dockeradapterwaitoptions) | Condition to be fulfilled. @see {DockerAdapterWaitOptions} |
507+
| `options` | [`DockerAdapterWaitOptions`](../modules.md#dockeradapterwaitoptions) | Condition to be fulfilled. |
504508

505509
#### Returns
506510

‎docs/adapters/classes/KubernetesSequenceAdapter.md‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Adapter for preparing Sequence to be run in process.
3535

3636
#### Defined in
3737

38-
[kubernetes-sequence-adapter.ts:53](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L53)
38+
[kubernetes-sequence-adapter.ts:56](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L56)
3939

4040
___
4141

@@ -49,7 +49,7 @@ ISequenceAdapter.logger
4949

5050
#### Defined in
5151

52-
[kubernetes-sequence-adapter.ts:49](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L49)
52+
[kubernetes-sequence-adapter.ts:52](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L52)
5353

5454
___
5555

@@ -63,7 +63,7 @@ ISequenceAdapter.name
6363

6464
#### Defined in
6565

66-
[kubernetes-sequence-adapter.ts:51](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L51)
66+
[kubernetes-sequence-adapter.ts:54](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L54)
6767

6868
## Constructors
6969

@@ -79,22 +79,23 @@ ISequenceAdapter.name
7979

8080
#### Defined in
8181

82-
[kubernetes-sequence-adapter.ts:55](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L55)
82+
[kubernetes-sequence-adapter.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L58)
8383

8484
## Methods
8585

8686
### identify
8787

88-
▸ **identify**(`stream`, `id`): `Promise`<`SequenceConfig`\>
88+
▸ **identify**(`stream`, `id`, `override?`): `Promise`<`SequenceConfig`\>
8989

9090
Unpacks and identifies sequence.
9191

9292
#### Parameters
9393

94-
| Name | Type | Description |
95-
| :------ | :------ | :------ |
96-
| `stream` | `Readable` | Stream with packed sequence. |
97-
| `id` | `string` | Sequence Id. |
94+
| Name | Type | Default value | Description |
95+
| :------ | :------ | :------ | :------ |
96+
| `stream` | `Readable` | `undefined` | Stream with packed sequence. |
97+
| `id` | `string` | `undefined` | Sequence Id. |
98+
| `override` | `boolean` | `false` | Removes previous sequence |
9899

99100
#### Returns
100101

@@ -108,7 +109,7 @@ ISequenceAdapter.identify
108109

109110
#### Defined in
110111

111-
[kubernetes-sequence-adapter.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L108)
112+
[kubernetes-sequence-adapter.ts:112](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L112)
112113

113114
___
114115

@@ -130,7 +131,7 @@ ISequenceAdapter.init
130131

131132
#### Defined in
132133

133-
[kubernetes-sequence-adapter.ts:71](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L71)
134+
[kubernetes-sequence-adapter.ts:74](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L74)
134135

135136
___
136137

@@ -152,7 +153,7 @@ ISequenceAdapter.list
152153

153154
#### Defined in
154155

155-
[kubernetes-sequence-adapter.ts:87](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L87)
156+
[kubernetes-sequence-adapter.ts:90](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L90)
156157

157158
___
158159

@@ -180,4 +181,4 @@ ISequenceAdapter.remove
180181

181182
#### Defined in
182183

183-
[kubernetes-sequence-adapter.ts:134](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L134)
184+
[kubernetes-sequence-adapter.ts:142](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/adapters/src/kubernetes-sequence-adapter.ts#L142)

0 commit comments

Comments
 (0)