Skip to content

Commit 8246d63

Browse files
authored
Merge pull request #816 from scramjetorg/devel
Prepare release v0.33.1
2 parents 62b5524 + 2447ccb commit 8246d63

Some content is hidden

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

50 files changed

+8814
-609
lines changed

docs/api-client/classes/HostClient.md

Lines changed: 65 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ Provides methods to interact with Host.
1313

1414
### Properties
1515

16+
- [#\_client](HostClient.md##_client)
1617
- [apiBase](HostClient.md#apibase)
18+
19+
### Accessors
20+
1721
- [client](HostClient.md#client)
1822

1923
### Constructors
@@ -23,6 +27,7 @@ Provides methods to interact with Host.
2327
### Methods
2428

2529
- [deleteSequence](HostClient.md#deletesequence)
30+
- [getAuditStream](HostClient.md#getauditstream)
2631
- [getConfig](HostClient.md#getconfig)
2732
- [getEntities](HostClient.md#getentities)
2833
- [getInstanceClient](HostClient.md#getinstanceclient)
@@ -43,6 +48,16 @@ Provides methods to interact with Host.
4348

4449
## Properties
4550

51+
### #\_client
52+
53+
`Private` **#\_client**: `ClientUtils`
54+
55+
#### Defined in
56+
57+
[api-client/src/host-client.ts:13](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L13)
58+
59+
___
60+
4661
### apiBase
4762

4863
**apiBase**: `string`
@@ -51,19 +66,23 @@ Provides methods to interact with Host.
5166

5267
[api-client/src/host-client.ts:11](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L11)
5368

54-
___
69+
## Accessors
5570

5671
### client
5772

58-
**client**: `ClientUtils`
73+
`get` **client**(): `ClientUtils`
74+
75+
#### Returns
76+
77+
`ClientUtils`
5978

6079
#### Implementation of
6180

6281
ClientProvider.client
6382

6483
#### Defined in
6584

66-
[api-client/src/host-client.ts:12](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L12)
85+
[api-client/src/host-client.ts:15](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L15)
6786

6887
## Constructors
6988

@@ -80,7 +99,7 @@ ClientProvider.client
8099

81100
#### Defined in
82101

83-
[api-client/src/host-client.ts:14](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L14)
102+
[api-client/src/host-client.ts:19](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L19)
84103

85104
## Methods
86105

@@ -104,7 +123,31 @@ Promise resolving to delete Sequence result.
104123

105124
#### Defined in
106125

107-
[api-client/src/host-client.ts:93](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L93)
126+
[api-client/src/host-client.ts:108](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L108)
127+
128+
___
129+
130+
### getAuditStream
131+
132+
**getAuditStream**(`requestInit?`): `Promise`<`Readable`\>
133+
134+
Returns Host log stream.
135+
136+
#### Parameters
137+
138+
| Name | Type | Description |
139+
| :------ | :------ | :------ |
140+
| `requestInit?` | `RequestInit` | RequestInit object to be passed to fetch. |
141+
142+
#### Returns
143+
144+
`Promise`<`Readable`\>
145+
146+
Promise resolving to response with log stream.
147+
148+
#### Defined in
149+
150+
[api-client/src/host-client.ts:58](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L58)
108151

109152
___
110153

@@ -122,7 +165,7 @@ Promise resolving to Host configuration (public part).
122165

123166
#### Defined in
124167

125-
[api-client/src/host-client.ts:138](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L138)
168+
[api-client/src/host-client.ts:153](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L153)
126169

127170
___
128171

@@ -136,7 +179,7 @@ ___
136179

137180
#### Defined in
138181

139-
[api-client/src/host-client.ts:198](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L198)
182+
[api-client/src/host-client.ts:213](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L213)
140183

141184
___
142185

@@ -160,7 +203,7 @@ InstanceClient instance.
160203

161204
#### Defined in
162205

163-
[api-client/src/host-client.ts:184](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L184)
206+
[api-client/src/host-client.ts:199](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L199)
164207

165208
___
166209

@@ -184,7 +227,7 @@ Promise resolving to Instance details.
184227

185228
#### Defined in
186229

187-
[api-client/src/host-client.ts:104](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L104)
230+
[api-client/src/host-client.ts:119](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L119)
188231

189232
___
190233

@@ -202,7 +245,7 @@ Promise resolving to Host load check data.
202245

203246
#### Defined in
204247

205-
[api-client/src/host-client.ts:113](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L113)
248+
[api-client/src/host-client.ts:128](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L128)
206249

207250
___
208251

@@ -226,7 +269,7 @@ Promise resolving to response with log stream.
226269

227270
#### Defined in
228271

229-
[api-client/src/host-client.ts:53](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L53)
272+
[api-client/src/host-client.ts:68](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L68)
230273

231274
___
232275

@@ -251,7 +294,7 @@ Promise resolving to readable stream.
251294

252295
#### Defined in
253296

254-
[api-client/src/host-client.ts:170](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L170)
297+
[api-client/src/host-client.ts:185](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L185)
255298

256299
___
257300

@@ -275,7 +318,7 @@ Promise resolving to Sequence details.
275318

276319
#### Defined in
277320

278-
[api-client/src/host-client.ts:83](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L83)
321+
[api-client/src/host-client.ts:98](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L98)
279322

280323
___
281324

@@ -299,7 +342,7 @@ SequenceClient instance.
299342

300343
#### Defined in
301344

302-
[api-client/src/host-client.ts:194](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L194)
345+
[api-client/src/host-client.ts:209](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L209)
303346

304347
___
305348

@@ -315,7 +358,7 @@ Returns Host status.
315358

316359
#### Defined in
317360

318-
[api-client/src/host-client.ts:129](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L129)
361+
[api-client/src/host-client.ts:144](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L144)
319362

320363
___
321364

@@ -329,7 +372,7 @@ ___
329372

330373
#### Defined in
331374

332-
[api-client/src/host-client.ts:174](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L174)
375+
[api-client/src/host-client.ts:189](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L189)
333376

334377
___
335378

@@ -347,7 +390,7 @@ Promise resolving to Host version.
347390

348391
#### Defined in
349392

350-
[api-client/src/host-client.ts:122](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L122)
393+
[api-client/src/host-client.ts:137](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L137)
351394

352395
___
353396

@@ -365,7 +408,7 @@ Promise resolving to list of entities.
365408

366409
#### Defined in
367410

368-
[api-client/src/host-client.ts:43](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L43)
411+
[api-client/src/host-client.ts:48](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L48)
369412

370413
___
371414

@@ -383,7 +426,7 @@ Promise resolving to list of Instances.
383426

384427
#### Defined in
385428

386-
[api-client/src/host-client.ts:34](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L34)
429+
[api-client/src/host-client.ts:39](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L39)
387430

388431
___
389432

@@ -401,7 +444,7 @@ Promise resolving to list of Sequences.
401444

402445
#### Defined in
403446

404-
[api-client/src/host-client.ts:25](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L25)
447+
[api-client/src/host-client.ts:30](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L30)
405448

406449
___
407450

@@ -436,7 +479,7 @@ TODO: comment.
436479

437480
#### Defined in
438481

439-
[api-client/src/host-client.ts:153](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L153)
482+
[api-client/src/host-client.ts:168](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L168)
440483

441484
___
442485

@@ -462,4 +505,4 @@ Sequence client.
462505

463506
#### Defined in
464507

465-
[api-client/src/host-client.ts:65](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L65)
508+
[api-client/src/host-client.ts:80](https://github.com/scramjetorg/transform-hub/blob/HEAD/packages/api-client/src/host-client.ts#L80)

0 commit comments

Comments
 (0)