chore: release 1.0.1

Author: timmywil

README.md

@@ -52,7 +52,7 @@ If you'd prefer to use Google ASR, follow these [instructions for setting up Goo
 
 ▸ **spokestackMiddleware**(): function
 
-_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/expressMiddleware.ts#L37)_
+_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/expressMiddleware.ts#L37)_
 
 Express middleware for adding a proxy to the Spokestack GraphQL API.
 A proxy is necessary to avoid exposing your Spokestack token secret on the client.
@@ -87,9 +87,9 @@ const graphQLFetcher = (graphQLParams) =>
 
 ### asrSocketServer
 
-▸ **asrSocketServer**(`server`: Server, `asrConfig?`: Omit\<SpokestackASRConfig, \"sampleRate\">): void
+▸ **asrSocketServer**(`server`: Server, `asrConfig?`: Omit<SpokestackASRConfig, \"sampleRate\"\>): void
 
-_Defined in [server/socketServer.ts:25](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/socketServer.ts#L25)_
+_Defined in [server/socketServer.ts:25](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/socketServer.ts#L25)_
 
 Adds a web socket server to the given HTTP server
 to stream ASR using Spokestack ASR.
@@ -111,7 +111,7 @@ server.listen(port, () => {
 | Name        | Type                                       | Default value |
 | ----------- | ------------------------------------------ | ------------- |
 | `server`    | Server                                     | -             |
-| `asrConfig` | Omit\<SpokestackASRConfig, \"sampleRate\"> | {}            |
+| `asrConfig` | Omit<SpokestackASRConfig, \"sampleRate\"\> | {}            |
 
 **Returns:** void
 
@@ -121,7 +121,7 @@ server.listen(port, () => {
 
 ▸ **googleASRSocketServer**(`server`: Server): void
 
-_Defined in [server/socketServer.ts:104](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/socketServer.ts#L104)_
+_Defined in [server/socketServer.ts:110](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/socketServer.ts#L110)_
 
 Adds a web socket server to the given HTTP server
 to stream ASR using Google Speech.
@@ -148,9 +148,9 @@ server.listen(port, () => {
 
 ### asr
 
-▸ **asr**(`content`: string \| Uint8Array, `sampleRate`: number): Promise\<string \| null>
+▸ **asr**(`content`: string \| Uint8Array, `sampleRate`: number): Promise<string \| null\>
 
-_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/asr.ts#L43)_
+_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/asr.ts#L43)_
 
 A one-off method for processing speech to text
 using Spokestack ASR.
@@ -195,15 +195,15 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
 | `content`    | string \| Uint8Array |
 | `sampleRate` | number               |
 
-**Returns:** Promise\<string \| null>
+**Returns:** Promise<string \| null\>
 
 ---
 
 ### googleASR
 
-▸ **googleASR**(`content`: string \| Uint8Array, `sampleRate`: number): Promise\<string \| null>
+▸ **googleASR**(`content`: string \| Uint8Array, `sampleRate`: number): Promise<string \| null\>
 
-_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/asr.ts#L97)_
+_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/asr.ts#L97)_
 
 A one-off method for processing speech to text
 using Google Speech.
@@ -248,13 +248,13 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
 | `content`    | string \| Uint8Array |
 | `sampleRate` | number               |
 
-**Returns:** Promise\<string \| null>
+**Returns:** Promise<string \| null\>
 
 ### encryptSecret
 
 ▸ **encryptSecret**(`body`: string): string
 
-_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/0075df2/src/server/encryptSecret.ts#L13)_
+_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/server/encryptSecret.ts#L13)_
 
 This is a convenience method for properly authorizing
 requests to the Spokestack graphql API.
@@ -281,9 +281,9 @@ These functions are available exports from `spokestack/client`.
 
 ### record
 
-▸ **record**(`config?`: RecordConfig): Promise\<AudioBuffer>
+▸ **record**(`config?`: RecordConfig): Promise<AudioBuffer\>
 
-_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/record.ts#L84)_
+_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/record.ts#L84)_
 
 A method to record audio for a given number of seconds
 
@@ -355,39 +355,39 @@ fetch('/asr', {
 | -------- | ------------ | ------------- |
 | `config` | RecordConfig | { time: 3 }   |
 
-**Returns:** Promise\<AudioBuffer>
+**Returns:** Promise<AudioBuffer\>
 
 #### RecordConfig
 
 ##### onProgress
 
 • `Optional` **onProgress**: undefined \| (remaining: number) => void
 
-_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/record.ts#L16)_
+_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/record.ts#L16)_
 
 A callback function to be called each second of recording.
 
 ##### onStart
 
 • `Optional` **onStart**: undefined \| () => void
 
-_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/record.ts#L14)_
+_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/record.ts#L14)_
 
 A callback function to be called when recording starts
 
 ##### time
 
 • `Optional` **time**: undefined \| number
 
-_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/record.ts#L12)_
+_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/record.ts#L12)_
 
 The total time to record. Default: 3
 
 ### startStream
 
-▸ **startStream**(`isPlaying`: () => boolean): Promise\<WebSocket>
+▸ **startStream**(`isPlaying`: () => boolean): Promise<WebSocket\>
 
-_Defined in [client/recordStream.ts:29](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/recordStream.ts#L29)_
+_Defined in [client/recordStream.ts:29](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/recordStream.ts#L29)_
 
 Returns a function to start recording using a native WebSocket.
 This assumes the socket is hosted on the current server.
@@ -412,15 +412,15 @@ try {
 | ----------- | ------------- | ------------------------------------------------------------------------------------------------------------- |
 | `isPlaying` | () => boolean | A function returning whether audio is currently playing. This is necessary to prevent recording played audio. |
 
-**Returns:** Promise\<WebSocket>
+**Returns:** Promise<WebSocket\>
 
 ---
 
 ### stopStream
 
 ▸ **stopStream**(): void
 
-_Defined in [client/recordStream.ts:79](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/recordStream.ts#L79)_
+_Defined in [client/recordStream.ts:79](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/recordStream.ts#L79)_
 
 Stop the current recording stream if one exists.
 
@@ -435,7 +435,7 @@ stopStream()
 
 ▸ **convertFloat32ToInt16**(`fp32Samples`: Float32Array): Int16Array
 
-_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/convertFloat32ToInt16.ts#L16)_
+_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/convertFloat32ToInt16.ts#L16)_
 
 A utility method to convert Float32Array audio
 to an Int16Array to be passed directly to Speech APIs
@@ -464,9 +464,9 @@ These are low-level functions for working with your own processors, available fr
 
 ### startProcessor
 
-▸ **startProcessor**(): Promise\<Error] \| [null, [ProcessorReturnValue]>
+▸ **startProcessor**(): Promise<Error] \| [null, [ProcessorReturnValue]\>
 
-_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/processor.ts#L32)_
+_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/processor.ts#L32)_
 
 Underlying utility method for recording audio,
 used by the `record` and `recordStream` methods.
@@ -477,15 +477,15 @@ See https://caniuse.com/#feat=mdn-api_audioworkletnode
 
 We'll switch to AudioWorklet when it does.
 
-**Returns:** Promise\<Error] \| [null, [ProcessorReturnValue]>
+**Returns:** Promise<Error] \| [null, [ProcessorReturnValue]\>
 
 ---
 
 ### stopProcessor
 
 ▸ **stopProcessor**(): void
 
-_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/processor.ts#L60)_
+_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/processor.ts#L60)_
 
 Underlying utility method to stop the current processor
 if it exists and disconnect the microphone.
@@ -498,19 +498,19 @@ if it exists and disconnect the microphone.
 
 • **context**: AudioContext
 
-_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/processor.ts#L18)_
+_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/processor.ts#L18)_
 
 ##### processor
 
 • **processor**: ScriptProcessorNode
 
-_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/processor.ts#L19)_
+_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/processor.ts#L19)_
 
 ### concatenateAudioBuffers
 
 ▸ **concatenateAudioBuffers**(`buffer1`: AudioBuffer, `buffer2`: AudioBuffer, `context`: AudioContext): null \| AudioBuffer
 
-_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/concatenateAudioBuffers.ts#L4)_
+_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/concatenateAudioBuffers.ts#L4)_
 
 A utility method to concatenate two AudioBuffers
 
@@ -528,7 +528,7 @@ A utility method to concatenate two AudioBuffers
 
 ▸ **countdown**(`time`: number, `progress`: (remaining: number) => void, `complete`: () => void): void
 
-_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/0075df2/src/client/countdown.ts#L7)_
+_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/e2289b2/src/client/countdown.ts#L7)_
 
 Countdown a number of seconds
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "spokestack",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Tools for integration with the Spokestack API in Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",