Updating Autogenerated Docs

docs/typedoc/classes/eventclient.md

@@ -28,15 +28,15 @@ Used to publish events to nitric topics
 
 **Returns:** [*EventClient*](eventclient.md)
 
-Defined in: [src/api/event/event.ts:13](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/event/event.ts#L13)
+Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/event/event.ts#L26)
 
 ## Properties
 
 ### grpcClient
 
 • `Private` **grpcClient**: [*EventClient*](grpc.event.eventclient.md)
 
-Defined in: [src/api/event/event.ts:13](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/event/event.ts#L13)
+Defined in: [src/api/event/event.ts:26](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/event/event.ts#L26)
 
 ## Methods
 
@@ -75,4 +75,4 @@ async function publishEvent(): string {
 }
 ```
 
-Defined in: [src/api/event/event.ts:46](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/event/event.ts#L46)
+Defined in: [src/api/event/event.ts:59](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/event/event.ts#L59)

docs/typedoc/classes/faas.nitriccontext.md

@@ -38,39 +38,39 @@ Name | Type |
 
 **Returns:** [*NitricContext*](faas.nitriccontext.md)
 
-Defined in: [src/faas/context.ts:7](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L7)
+Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L20)
 
 ## Properties
 
 ### payloadType
 
 • `Readonly` **payloadType**: *string*
 
-Defined in: [src/faas/context.ts:7](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L7)
+Defined in: [src/faas/context.ts:20](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L20)
 
 ___
 
 ### requestId
 
 • `Readonly` **requestId**: *string*
 
-Defined in: [src/faas/context.ts:4](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L4)
+Defined in: [src/faas/context.ts:17](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L17)
 
 ___
 
 ### source
 
 • `Readonly` **source**: *string*
 
-Defined in: [src/faas/context.ts:5](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L5)
+Defined in: [src/faas/context.ts:18](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L18)
 
 ___
 
 ### sourceType
 
 • `Readonly` **sourceType**: [*NitricSourceType*](../modules/faas.md#nitricsourcetype)
 
-Defined in: [src/faas/context.ts:6](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L6)
+Defined in: [src/faas/context.ts:19](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L19)
 
 ## Methods
 
@@ -86,4 +86,4 @@ Name | Type |
 
 **Returns:** [*NitricContext*](faas.nitriccontext.md)
 
-Defined in: [src/faas/context.ts:16](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L16)
+Defined in: [src/faas/context.ts:33](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L33)

docs/typedoc/classes/faas.nitricrequest.md

@@ -55,31 +55,31 @@ Name | Type |
 
 **Returns:** [*NitricRequest*](faas.nitricrequest.md)<T\>
 
-Defined in: [src/faas/request.ts:18](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L18)
+Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L31)
 
 ## Properties
 
 ### context
 
 • `Private` **context**: [*NitricContext*](faas.nitriccontext.md)
 
-Defined in: [src/faas/request.ts:18](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L18)
+Defined in: [src/faas/request.ts:31](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L31)
 
 ___
 
 ### path
 
 • `Private` **path**: *string*
 
-Defined in: [src/faas/request.ts:15](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L15)
+Defined in: [src/faas/request.ts:28](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L28)
 
 ___
 
 ### payload
 
 • `Private` **payload**: *Uint8Array*
 
-Defined in: [src/faas/request.ts:14](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L14)
+Defined in: [src/faas/request.ts:27](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L27)
 
 ## Methods
 
@@ -91,7 +91,7 @@ Return the raw body as bytes
 
 **Returns:** *Uint8Array*
 
-Defined in: [src/faas/request.ts:75](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L75)
+Defined in: [src/faas/request.ts:90](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L90)
 
 ___
 
@@ -101,7 +101,7 @@ ___
 
 **Returns:** [*NitricContext*](faas.nitriccontext.md)
 
-Defined in: [src/faas/request.ts:38](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L38)
+Defined in: [src/faas/request.ts:55](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L55)
 
 ___
 
@@ -114,7 +114,7 @@ Will throw in the case where the object cannot be correctly serialized...
 
 **Returns:** T
 
-Defined in: [src/faas/request.ts:90](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L90)
+Defined in: [src/faas/request.ts:105](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L105)
 
 ___
 
@@ -132,7 +132,7 @@ Name | Type | Description |
 
 **Returns:** RequestParameters
 
-Defined in: [src/faas/request.ts:46](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L46)
+Defined in: [src/faas/request.ts:63](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L63)
 
 ___
 
@@ -144,7 +144,7 @@ Return the payload as a string
 
 **Returns:** *string*
 
-Defined in: [src/faas/request.ts:82](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L82)
+Defined in: [src/faas/request.ts:97](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L97)
 
 ___
 
@@ -158,4 +158,4 @@ Does the request contain a body
 
 true when the body is defined and false if the body is undefined or null
 
-Defined in: [src/faas/request.ts:68](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/request.ts#L68)
+Defined in: [src/faas/request.ts:83](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/request.ts#L83)

docs/typedoc/classes/keyvalueclient.md

@@ -49,23 +49,23 @@ Name | Type |
 
 **Returns:** [*KeyValueClient*](keyvalueclient.md)<T\>
 
-Defined in: [src/api/kv/kv.ts:13](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L13)
+Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L26)
 
 ## Properties
 
 ### collection
 
 • `Private` **collection**: *string*
 
-Defined in: [src/api/kv/kv.ts:13](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L13)
+Defined in: [src/api/kv/kv.ts:26](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L26)
 
 ___
 
 ### grpcClient
 
 • `Private` **grpcClient**: [*KeyValueClient*](grpc.kv.keyvalueclient.md)
 
-Defined in: [src/api/kv/kv.ts:12](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L12)
+Defined in: [src/api/kv/kv.ts:25](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L25)
 
 ## Methods
 
@@ -89,12 +89,12 @@ Example:
 ```typescript
 import { KeyValueClient } from "@nitric/sdk";
 
-const client = new KeyValueClient<any>("products"); 
+const client = new KeyValueClient<any>("products");
 
 await client.delete("nitric");
 ```
 
-Defined in: [src/api/kv/kv.ts:121](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L121)
+Defined in: [src/api/kv/kv.ts:134](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L134)
 
 ___
 
@@ -129,7 +129,7 @@ const client = new KeyValueClient<Product>("products");
 const product = await client.get("nitric");
 ```
 
-Defined in: [src/api/kv/kv.ts:89](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L89)
+Defined in: [src/api/kv/kv.ts:102](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L102)
 
 ___
 
@@ -169,4 +169,4 @@ await client.put("nitric", {
 });
 ```
 
-Defined in: [src/api/kv/kv.ts:48](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/kv/kv.ts#L48)
+Defined in: [src/api/kv/kv.ts:61](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/kv/kv.ts#L61)

docs/typedoc/classes/queueclient.md

@@ -29,15 +29,15 @@ Nitric queue client, facilitates pushing and popping to distributed queues.
 
 **Returns:** [*QueueClient*](queueclient.md)
 
-Defined in: [src/api/queue/queue.ts:31](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L31)
+Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L43)
 
 ## Properties
 
 ### grpcClient
 
 • `Private` **grpcClient**: [*QueueClient*](grpc.queue.queueclient.md)
 
-Defined in: [src/api/queue/queue.ts:31](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L31)
+Defined in: [src/api/queue/queue.ts:43](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L43)
 
 ## Methods
 
@@ -69,10 +69,10 @@ const [task] = await client.receive("my-queue");
 // do something with task
 
 // complete the task
-client.complete("my-queue", task); 
+client.complete("my-queue", task);
 ```
 
-Defined in: [src/api/queue/queue.ts:209](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L209)
+Defined in: [src/api/queue/queue.ts:218](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L218)
 
 ___
 
@@ -109,7 +109,7 @@ const [task] = await client.receive("my-queue");
 // do something with task
 ```
 
-Defined in: [src/api/queue/queue.ts:157](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L157)
+Defined in: [src/api/queue/queue.ts:166](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L166)
 
 ___
 
@@ -145,7 +145,7 @@ await client.send("my-queue", {
 });
 ```
 
-Defined in: [src/api/queue/queue.ts:62](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L62)
+Defined in: [src/api/queue/queue.ts:74](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L74)
 
 ___
 
@@ -183,4 +183,4 @@ const failedTasks = await client.sendBatch("my-queue", [{
 // console.log(failedTasks);
 ```
 
-Defined in: [src/api/queue/queue.ts:103](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/queue/queue.ts#L103)
+Defined in: [src/api/queue/queue.ts:115](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/queue/queue.ts#L115)

docs/typedoc/classes/storageclient.md

@@ -27,15 +27,15 @@ Nitric queue client, facilitates writing and reading from blob storate (buckets)
 
 **Returns:** [*StorageClient*](storageclient.md)
 
-Defined in: [src/api/storage/storage.ts:9](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/storage/storage.ts#L9)
+Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/storage/storage.ts#L22)
 
 ## Properties
 
 ### grpcClient
 
 • `Private` **grpcClient**: [*StorageClient*](grpc.storage.storageclient.md)
 
-Defined in: [src/api/storage/storage.ts:9](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/storage/storage.ts#L9)
+Defined in: [src/api/storage/storage.ts:22](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/storage/storage.ts#L22)
 
 ## Methods
 
@@ -65,7 +65,7 @@ const client = new StorageClient();
 const bytes = await client.read("my-bucket", "my-item");
 ```
 
-Defined in: [src/api/storage/storage.ts:66](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/storage/storage.ts#L66)
+Defined in: [src/api/storage/storage.ts:79](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/storage/storage.ts#L79)
 
 ___
 
@@ -96,4 +96,4 @@ Name | Type | Description |
 
 **Returns:** *Promise*<void\>
 
-Defined in: [src/api/storage/storage.ts:34](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/storage/storage.ts#L34)
+Defined in: [src/api/storage/storage.ts:47](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/storage/storage.ts#L47)

docs/typedoc/classes/topicclient.md

@@ -26,15 +26,15 @@ Nitric client for managing topics
 
 **Returns:** [*TopicClient*](topicclient.md)
 
-Defined in: [src/api/topic/topic.ts:9](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/topic/topic.ts#L9)
+Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/topic/topic.ts#L22)
 
 ## Properties
 
 ### grpcClient
 
 • `Private` **grpcClient**: [*TopicClient*](grpc.event.topicclient.md)
 
-Defined in: [src/api/topic/topic.ts:9](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/topic/topic.ts#L9)
+Defined in: [src/api/topic/topic.ts:22](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/topic/topic.ts#L22)
 
 ## Methods
 
@@ -59,4 +59,4 @@ const topics = await client.list();
 
 **Returns:** *Promise*<string[]\>
 
-Defined in: [src/api/topic/topic.ts:34](https://github.com/nitrictech/node-sdk/blob/1154827/src/api/topic/topic.ts#L34)
+Defined in: [src/api/topic/topic.ts:47](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/api/topic/topic.ts#L47)

docs/typedoc/interfaces/faas.nitricresponse.md

@@ -24,20 +24,20 @@ Name |
 
 • **body**: *Uint8Array* \| P
 
-Defined in: [src/faas/response.ts:4](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/response.ts#L4)
+Defined in: [src/faas/response.ts:17](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/response.ts#L17)
 
 ___
 
 ### headers
 
 • **headers**: *Record*<string, string\>
 
-Defined in: [src/faas/response.ts:2](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/response.ts#L2)
+Defined in: [src/faas/response.ts:15](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/response.ts#L15)
 
 ___
 
 ### status
 
 • **status**: *number*
 
-Defined in: [src/faas/response.ts:3](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/response.ts#L3)
+Defined in: [src/faas/response.ts:16](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/response.ts#L16)

docs/typedoc/modules/faas.md

@@ -52,21 +52,21 @@ Name | Type |
 
 **Returns:** *Promise*<[*NitricResponse*](../interfaces/faas.nitricresponse.md)<T\>\> \| *Promise*<T\> \| [*NitricResponse*](../interfaces/faas.nitricresponse.md)<T\> \| T
 
-Defined in: [src/faas/function.ts:12](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/function.ts#L12)
+Defined in: [src/faas/function.ts:25](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/function.ts#L25)
 
 ___
 
 ### NitricSourceType
 
 Ƭ **NitricSourceType**: *REQUEST* \| *SUBSCRIPTION* \| *UNKNOWN*
 
-Defined in: [src/faas/context.ts:1](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/context.ts#L1)
+Defined in: [src/faas/context.ts:14](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/context.ts#L14)
 
 ## Functions
 
 ### start
 
-▸ **start**<Request, Response\>(`func`: [*NitricFunction*](faas.md#nitricfunction)<Request, Response\>): *Promise*<void\>
+▸ **start**<Request, Response\>(`func`: [*NitricFunction*](faas.md#nitricfunction)<Request, Response\>): *Promise*<Server\>
 
 Starts a nitric function
 
@@ -101,6 +101,6 @@ Name | Type | Description |
 :------ | :------ | :------ |
 `func` | [*NitricFunction*](faas.md#nitricfunction)<Request, Response\> | The function handler see [NitricFunction](faas.md#nitricfunction)   |
 
-**Returns:** *Promise*<void\>
+**Returns:** *Promise*<Server\>
 
-Defined in: [src/faas/start.ts:30](https://github.com/nitrictech/node-sdk/blob/1154827/src/faas/start.ts#L30)
+Defined in: [src/faas/start.ts:47](https://github.com/nitrictech/node-sdk/blob/7bd7506/src/faas/start.ts#L47)