Skip to content

Commit 086926f

Browse files
Updating Autogenerated Docs
1 parent c7411df commit 086926f

File tree

9 files changed

+45
-91
lines changed

9 files changed

+45
-91
lines changed

docs/typedoc/classes/eventclient.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ Used to publish events to nitric topics
2828

2929
**Returns:** [*EventClient*](eventclient.md)
3030

31-
Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/event/event.ts#L26)
31+
Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/event/event.ts#L26)
3232

3333
## Properties
3434

3535
### grpcClient
3636

3737
`Private` **grpcClient**: [*EventClient*](grpc.event.eventclient.md)
3838

39-
Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/event/event.ts#L26)
39+
Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/event/event.ts#L26)
4040

4141
## Methods
4242

@@ -75,4 +75,4 @@ async function publishEvent(): string {
7575
}
7676
```
7777

78-
Defined in: [src/api/event/event.ts:59](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/event/event.ts#L59)
78+
Defined in: [src/api/event/event.ts:59](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/event/event.ts#L59)

docs/typedoc/classes/faas.nitriccontext.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,39 +38,39 @@ Name | Type |
3838

3939
**Returns:** [*NitricContext*](faas.nitriccontext.md)
4040

41-
Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L20)
41+
Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L20)
4242

4343
## Properties
4444

4545
### payloadType
4646

4747
`Readonly` **payloadType**: *string*
4848

49-
Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L20)
49+
Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L20)
5050

5151
___
5252

5353
### requestId
5454

5555
`Readonly` **requestId**: *string*
5656

57-
Defined in: [src/faas/context.ts:17](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L17)
57+
Defined in: [src/faas/context.ts:17](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L17)
5858

5959
___
6060

6161
### source
6262

6363
`Readonly` **source**: *string*
6464

65-
Defined in: [src/faas/context.ts:18](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L18)
65+
Defined in: [src/faas/context.ts:18](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L18)
6666

6767
___
6868

6969
### sourceType
7070

7171
`Readonly` **sourceType**: [*NitricSourceType*](../modules/faas.md#nitricsourcetype)
7272

73-
Defined in: [src/faas/context.ts:19](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L19)
73+
Defined in: [src/faas/context.ts:19](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L19)
7474

7575
## Methods
7676

@@ -86,4 +86,4 @@ Name | Type |
8686

8787
**Returns:** [*NitricContext*](faas.nitriccontext.md)
8888

89-
Defined in: [src/faas/context.ts:33](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/context.ts#L33)
89+
Defined in: [src/faas/context.ts:33](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/context.ts#L33)

docs/typedoc/classes/faas.nitricrequest.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,31 +55,31 @@ Name | Type |
5555

5656
**Returns:** [*NitricRequest*](faas.nitricrequest.md)<T\>
5757

58-
Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L31)
58+
Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L31)
5959

6060
## Properties
6161

6262
### context
6363

6464
`Private` **context**: [*NitricContext*](faas.nitriccontext.md)
6565

66-
Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L31)
66+
Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L31)
6767

6868
___
6969

7070
### path
7171

7272
`Private` **path**: *string*
7373

74-
Defined in: [src/faas/request.ts:28](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L28)
74+
Defined in: [src/faas/request.ts:28](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L28)
7575

7676
___
7777

7878
### payload
7979

8080
`Private` **payload**: *Uint8Array*
8181

82-
Defined in: [src/faas/request.ts:27](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L27)
82+
Defined in: [src/faas/request.ts:27](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L27)
8383

8484
## Methods
8585

@@ -91,7 +91,7 @@ Return the raw body as bytes
9191

9292
**Returns:** *Uint8Array*
9393

94-
Defined in: [src/faas/request.ts:90](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L90)
94+
Defined in: [src/faas/request.ts:90](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L90)
9595

9696
___
9797

@@ -101,7 +101,7 @@ ___
101101

102102
**Returns:** [*NitricContext*](faas.nitriccontext.md)
103103

104-
Defined in: [src/faas/request.ts:55](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L55)
104+
Defined in: [src/faas/request.ts:55](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L55)
105105

106106
___
107107

@@ -114,7 +114,7 @@ Will throw in the case where the object cannot be correctly serialized...
114114

115115
**Returns:** T
116116

117-
Defined in: [src/faas/request.ts:105](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L105)
117+
Defined in: [src/faas/request.ts:105](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L105)
118118

119119
___
120120

@@ -132,7 +132,7 @@ Name | Type | Description |
132132

133133
**Returns:** RequestParameters
134134

135-
Defined in: [src/faas/request.ts:63](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L63)
135+
Defined in: [src/faas/request.ts:63](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L63)
136136

137137
___
138138

@@ -144,7 +144,7 @@ Return the payload as a string
144144

145145
**Returns:** *string*
146146

147-
Defined in: [src/faas/request.ts:97](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L97)
147+
Defined in: [src/faas/request.ts:97](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L97)
148148

149149
___
150150

@@ -158,4 +158,4 @@ Does the request contain a body
158158

159159
true when the body is defined and false if the body is undefined or null
160160

161-
Defined in: [src/faas/request.ts:83](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/faas/request.ts#L83)
161+
Defined in: [src/faas/request.ts:83](https://github.com/nitrictech/node-sdk/blob/c7411df/src/faas/request.ts#L83)

docs/typedoc/classes/keyvalueclient.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,23 +49,23 @@ Name | Type |
4949

5050
**Returns:** [*KeyValueClient*](keyvalueclient.md)<T\>
5151

52-
Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L26)
52+
Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L26)
5353

5454
## Properties
5555

5656
### collection
5757

5858
`Private` **collection**: *string*
5959

60-
Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L26)
60+
Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L26)
6161

6262
___
6363

6464
### grpcClient
6565

6666
`Private` **grpcClient**: [*KeyValueClient*](grpc.kv.keyvalueclient.md)
6767

68-
Defined in: [src/api/kv/kv.ts:25](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L25)
68+
Defined in: [src/api/kv/kv.ts:25](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L25)
6969

7070
## Methods
7171

@@ -94,7 +94,7 @@ const client = new KeyValueClient<any>("products");
9494
await client.delete("nitric");
9595
```
9696

97-
Defined in: [src/api/kv/kv.ts:134](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L134)
97+
Defined in: [src/api/kv/kv.ts:134](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L134)
9898

9999
___
100100

@@ -129,7 +129,7 @@ const client = new KeyValueClient<Product>("products");
129129
const product = await client.get("nitric");
130130
```
131131

132-
Defined in: [src/api/kv/kv.ts:102](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L102)
132+
Defined in: [src/api/kv/kv.ts:102](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L102)
133133

134134
___
135135

@@ -169,4 +169,4 @@ await client.put("nitric", {
169169
});
170170
```
171171

172-
Defined in: [src/api/kv/kv.ts:61](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/kv/kv.ts#L61)
172+
Defined in: [src/api/kv/kv.ts:61](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/kv/kv.ts#L61)

docs/typedoc/classes/queueclient.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ Nitric queue client, facilitates pushing and popping to distributed queues.
2929

3030
**Returns:** [*QueueClient*](queueclient.md)
3131

32-
Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L43)
32+
Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L43)
3333

3434
## Properties
3535

3636
### grpcClient
3737

3838
`Private` **grpcClient**: [*QueueClient*](grpc.queue.queueclient.md)
3939

40-
Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L43)
40+
Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L43)
4141

4242
## Methods
4343

@@ -72,7 +72,7 @@ const [task] = await client.receive("my-queue");
7272
client.complete("my-queue", task);
7373
```
7474

75-
Defined in: [src/api/queue/queue.ts:218](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L218)
75+
Defined in: [src/api/queue/queue.ts:218](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L218)
7676

7777
___
7878

@@ -109,7 +109,7 @@ const [task] = await client.receive("my-queue");
109109
// do something with task
110110
```
111111

112-
Defined in: [src/api/queue/queue.ts:166](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L166)
112+
Defined in: [src/api/queue/queue.ts:166](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L166)
113113

114114
___
115115

@@ -145,7 +145,7 @@ await client.send("my-queue", {
145145
});
146146
```
147147

148-
Defined in: [src/api/queue/queue.ts:74](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L74)
148+
Defined in: [src/api/queue/queue.ts:74](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L74)
149149

150150
___
151151

@@ -183,4 +183,4 @@ const failedTasks = await client.sendBatch("my-queue", [{
183183
// console.log(failedTasks);
184184
```
185185

186-
Defined in: [src/api/queue/queue.ts:115](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/queue/queue.ts#L115)
186+
Defined in: [src/api/queue/queue.ts:115](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/queue/queue.ts#L115)

docs/typedoc/classes/storageclient.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ Nitric queue client, facilitates writing and reading from blob storate (buckets)
2727

2828
**Returns:** [*StorageClient*](storageclient.md)
2929

30-
Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/storage/storage.ts#L22)
30+
Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/storage/storage.ts#L22)
3131

3232
## Properties
3333

3434
### grpcClient
3535

3636
`Private` **grpcClient**: [*StorageClient*](grpc.storage.storageclient.md)
3737

38-
Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/storage/storage.ts#L22)
38+
Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/storage/storage.ts#L22)
3939

4040
## Methods
4141

@@ -65,7 +65,7 @@ const client = new StorageClient();
6565
const bytes = await client.read("my-bucket", "my-item");
6666
```
6767

68-
Defined in: [src/api/storage/storage.ts:79](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/storage/storage.ts#L79)
68+
Defined in: [src/api/storage/storage.ts:79](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/storage/storage.ts#L79)
6969

7070
___
7171

@@ -96,4 +96,4 @@ Name | Type | Description |
9696

9797
**Returns:** *Promise*<void\>
9898

99-
Defined in: [src/api/storage/storage.ts:47](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/storage/storage.ts#L47)
99+
Defined in: [src/api/storage/storage.ts:47](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/storage/storage.ts#L47)

docs/typedoc/classes/topicclient.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ Nitric client for managing topics
2626

2727
**Returns:** [*TopicClient*](topicclient.md)
2828

29-
Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/topic/topic.ts#L22)
29+
Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/topic/topic.ts#L22)
3030

3131
## Properties
3232

3333
### grpcClient
3434

3535
`Private` **grpcClient**: [*TopicClient*](grpc.event.topicclient.md)
3636

37-
Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/topic/topic.ts#L22)
37+
Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/topic/topic.ts#L22)
3838

3939
## Methods
4040

@@ -59,4 +59,4 @@ const topics = await client.list();
5959

6060
**Returns:** *Promise*<string[]\>
6161

62-
Defined in: [src/api/topic/topic.ts:47](https://github.com/nitrictech/node-sdk/blob/0bd29fc/src/api/topic/topic.ts#L47)
62+
Defined in: [src/api/topic/topic.ts:47](https://github.com/nitrictech/node-sdk/blob/c7411df/src/api/topic/topic.ts#L47)

docs/typedoc/interfaces/faas.nitricresponse.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)