@isdk/ai-tool 0.6.0 → 0.7.0

package/docs/api/interfaces/FuncItem.md

@@ -0,0 +1,281 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FuncItem
+
+# Interface: FuncItem
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L184)
+
+Extends `BaseFuncItem` to include the actual function implementation.
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Properties
+
+### alias?
+
+> `optional` **alias**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
+
+Optional aliases for the function name.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`alias`](BaseFuncItem.md#alias)
+
+***
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
+
+A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
+This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
+
+#### See
+
+AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
+
+#### Example
+
+```ts
+import { AsyncFeatures } from './utils';
+const func = new ToolFunc({
+  name: 'cancellableTask',
+  asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
+  // ...
+});
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`asyncFeatures`](BaseFuncItem.md#asyncfeatures)
+
+***
+
+### depends?
+
+> `optional` **depends**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
+
+A map of dependencies this function has on other tool functions.
+Declaring dependencies ensures that they are automatically registered when this function is registered.
+This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Example
+
+```ts
+const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
+const mainFunc = new ToolFunc({
+  name: 'main',
+  depends: {
+    helper: helperFunc,
+  },
+  func() {
+    // We can now safely run the dependency
+    const result = this.runSync('helper');
+    return `Hello, ${result}`;
+  }
+});
+// When mainFunc is registered, helperFunc will be registered automatically.
+mainFunc.register();
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`depends`](BaseFuncItem.md#depends)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
+
+A detailed description of what the function does.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`description`](BaseFuncItem.md#description)
+
+***
+
+### func?
+
+> `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:189](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L189)
+
+The implementation of the tool function.
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
+
+If true, indicates that this function should be treated as a server-side API.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
+
+The unique name of the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name-2)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
+
+Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
+
+The expected return type of the function, described as a string or a JSON schema object.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
+
+The execution scope or context (`this`) for the function.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
+
+A lifecycle hook called once during the `ToolFunc` instance's initialization.
+It allows for initial setup, state configuration, or property modification on the instance
+before it is used or registered. The `this` context is the `ToolFunc` instance itself.
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+The configuration options for the function.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const myFunc = new ToolFunc({
+  name: 'myFunc',
+  customState: 'initial',
+  setup() {
+    // `this` is the myFunc instance
+    this.customState = 'configured';
+  }
+});
+console.log(myFunc.customState); // Outputs: 'configured'
+```
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
+
+If true, indicates that the function has the *capability* to stream its output.
+Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
+
+Tags for grouping or filtering functions.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
+
+A concise, human-readable title for the function, often used in UI or by AI.
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`title`](BaseFuncItem.md#title)

package/docs/api/interfaces/FuncParam.md

@@ -0,0 +1,51 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FuncParam
+
+# Interface: FuncParam
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L15)
+
+Describes a single function parameter, including its name, type, and description.
+
+## Properties
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L38)
+
+A description of the parameter, explaining its purpose and usage.
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L20)
+
+The name of the parameter.
+
+***
+
+### required?
+
+> `optional` **required**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:32](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L32)
+
+Indicates whether the parameter is required.
+
+***
+
+### type?
+
+> `optional` **type**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L26)
+
+The data type of the parameter, represented as a string identifier (e.g., 'string', 'number').

package/docs/api/interfaces/FuncParams.md

@@ -0,0 +1,28 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FuncParams
+
+# Interface: FuncParams
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:54](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L54)
+
+A map of function parameters, where each key is the parameter name.
+The value can be either a detailed `FuncParam` object or a simple type string.
+
+## Example
+
+```ts
+const params: FuncParams = {
+  userId: 'string',
+  profile: {
+    type: 'object',
+    description: 'User profile data'
+  }
+};
+```
+
+## Indexable
+
+\[`name`: `string`\]: `string` \| [`FuncParam`](FuncParam.md)

package/docs/api/interfaces/Funcs.md

@@ -0,0 +1,15 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / Funcs
+
+# Interface: Funcs
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:208](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L208)
+
+A map of registered `ToolFunc` instances, indexed by their names.
+
+## Indexable
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)

package/docs/api/interfaces/HashAlgoParams.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / HashAlgoParams
+
+# Interface: HashAlgoParams
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/hash.ts#L10)
+
+## Properties
+
+### hashAlgo?
+
+> `optional` **hashAlgo**: [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/hash.ts#L11)
+
+***
+
+### outputType?
+
+> `optional` **outputType**: `"string"` \| `"hex"` \| `"binary"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:13](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/hash.ts#L13)
+
+***
+
+### seed?
+
+> `optional` **seed**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/hash.ts#L12)

package/docs/api/interfaces/IClientToolTransport.md

@@ -0,0 +1,155 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / IClientToolTransport
+
+# Interface: IClientToolTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L10)
+
+Defines the public interface for a client-side transport,
+responsible for communicating with a ServerTransport.
+
+## Extends
+
+- [`IToolTransport`](IToolTransport.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L22)
+
+The root endpoint for the remote service.
+For HTTP, this is a URL. For IPC, it could be a channel name.
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`apiRoot`](IToolTransport.md#apiroot)
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L26)
+
+Additional options for the transport start or fetch, passed by mount.
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`options`](IToolTransport.md#options)
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L17)
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`Tools`](IToolTransport.md#tools)
+
+## Methods
+
+### fetch()
+
+> **fetch**(`name`, `args`?, `act`?, `subName`?, `options`?): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:28](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L28)
+
+Fetches data from the server.
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the tool function to fetch.
+
+##### args?
+
+`any`
+
+The object parameters to pass to the server.
+
+##### act?
+
+`string`
+
+The action to perform on the server.
+
+##### subName?
+
+`any`
+
+The name of the sub-resource to fetch.
+
+##### options?
+
+`any`
+
+Additional options for the fetch call.
+
+#### Returns
+
+`any`
+
+A promise that resolves with the fetched data.
+
+***
+
+### loadApis()
+
+> **loadApis**(): `Promise`\<[`Funcs`](Funcs.md)\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L15)
+
+Connects to the server's discovery endpoint to get the list of available tools.
+
+#### Returns
+
+`Promise`\<[`Funcs`](Funcs.md)\>
+
+A promise that resolves to a map of tool function metadata.
+
+***
+
+### mount()
+
+> **mount**(`clientTools`, `apiPrefix`?, `options`?): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L17)
+
+#### Parameters
+
+##### clientTools
+
+*typeof* [`ClientTools`](../classes/ClientTools.md)
+
+##### apiPrefix?
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`any`
+
+#### Overrides
+
+[`IToolTransport`](IToolTransport.md).[`mount`](IToolTransport.md#mount)

package/docs/api/interfaces/IFileMetaInfo.md

@@ -0,0 +1,65 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / IFileMetaInfo
+
+# Interface: IFileMetaInfo
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:225](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L225)
+
+## Properties
+
+### ctime
+
+> **ctime**: `Date`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:228](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L228)
+
+***
+
+### hash
+
+> **hash**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:230](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L230)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:232](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L232)
+
+***
+
+### mimeType
+
+> **mimeType**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:231](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L231)
+
+***
+
+### mtime
+
+> **mtime**: `Date`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:227](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L227)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:226](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L226)
+
+***
+
+### size
+
+> **size**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:229](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-file-from-paths.ts#L229)

package/docs/api/interfaces/IPubSubClientTransport.md

@@ -0,0 +1,70 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / IPubSubClientTransport
+
+# Interface: IPubSubClientTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:74](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L74)
+
+Defines the interface for a client-side PubSub transport.
+
+This abstraction is responsible for creating and managing the connection
+stream (`PubSubClientStream`) to the server.
+
+## Properties
+
+### connect()
+
+> **connect**: (`url`, `params`?) => [`PubSubClientStream`](PubSubClientStream.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:82](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L82)
+
+Establishes a connection to a server endpoint.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL of the server's PubSub endpoint.
+
+##### params?
+
+`Record`\<`string`, `any`\>
+
+Optional parameters for the connection, which might include
+  things like authentication tokens, initial subscription topics, or a client ID.
+
+#### Returns
+
+[`PubSubClientStream`](PubSubClientStream.md)
+
+A `PubSubClientStream` instance that represents the active connection.
+
+***
+
+### disconnect()?
+
+> `optional` **disconnect**: (`stream`) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/client.ts#L91)
+
+Optional. Disconnects a given stream.
+While the `close` method exists on the stream itself, placing `disconnect`
+on the transport can be semantically clearer in some architectures.
+By default, this should delegate to `stream.close()`.
+
+#### Parameters
+
+##### stream
+
+[`PubSubClientStream`](PubSubClientStream.md)
+
+The stream to disconnect.
+
+#### Returns
+
+`void`