# @hackdance/hooks > > [!WARNING] > The agents and hooks packages are no longer maintained and schema-stream has moved here: [island-ai](https://github.com/hack-dance/island-ai) > Agents has been mostly replaced by zod-stream and the hooks package has moved to stream-hooks - Latest version **4.0.1** (published 2024-02-21) · MIT license · 0 weekly downloads ## Install ```sh npm install @hackdance/hooks pnpm add @hackdance/hooks yarn add @hackdance/hooks bun add @hackdance/hooks ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 4.0.1 | | Published | 2024-02-21 | | First published | 2023-10-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 59.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 7 | | Author | Dimitri Kennedy | | Maintainers | dimitrikennedy | ## Links - npm: https://www.npmjs.com/package/@hackdance/hooks - Repository: https://github.com/hack-dance/agents - Homepage: https://island.novy.work - Issues: https://github.com/hack-dance/agents/issues - npm.io page: https://npm.io/package/@hackdance/hooks ## Recent versions - 4.0.1 (latest) — 2024-02-21 - 4.0.0 — 2024-01-05 - 3.0.1 — 2024-01-03 - 3.0.0 — 2024-01-03 - 2.0.0 — 2023-12-08 - 1.0.0 — 2023-12-07 - 0.2.0 — 2023-12-04 - 0.1.1 — 2023-10-19 - 0.1.0 — 2023-10-19 - 0.0.6 — 2023-10-11 - 0.0.5 — 2023-10-11 - 0.0.4 — 2023-10-11 - 0.0.3 — 2023-10-11 - 0.0.2 — 2023-10-11 - 0.0.1 — 2023-10-11 ## README > [!WARNING] > The agents and hooks packages are no longer maintained and schema-stream has moved here: [island-ai](https://github.com/hack-dance/island-ai) > Agents has been mostly replaced by zod-stream and the hooks package has moved to stream-hooks - now both part of the island-ai project. # @hackdance/hooks This package provides three custom React hooks for managing streams, chat streams, and JSON streams. ## Installation To install the package, run the following command: ```bash pnpm add @hackdance/hooks ``` ## Hooks ### useStream `useStream` is a custom React hook that manages a stream. It provides functionalities to start and stop the stream. #### Props | Name | Type | Description | | ------------- | -------- | ----------- | | onBeforeStart | function | Optional callback function that will be invoked before the stream starts. | | onStop | function | Optional callback function that will be invoked when the stream stops. | #### Usage ```jsx import { useStream } from '@hackdance/hooks'; const { startStream, stopStream } = useStream({ onBeforeStart: ..., onStop: ... }); ``` ### useChatStream `useChatStream` is a custom React hook that extends the `useStream` hook to manage a chat stream. It provides functionalities to start and stop the chat stream, manage the chat messages, and manage the loading state. #### Props | Name | Type | Description | | ---------------- | -------- | ----------- | | onReceive | function | Optional callback function that will be invoked when a message is received. | | onEnd | function | Optional callback function that will be invoked when the chat stream ends. | | startingMessages | array | Optional array of starting messages. | | ctx | object | Optional static context object, appended to every post body on each startStream invocation . | | defaultMethod | string | Optional method for the request, one of GET | POST defaults to POST. | | defaultHeaders | object | Optional request headers | #### Usage ```jsx import { useChatStream } from '@hackdance/hooks' const { loading, startStream, stopStream, messages, setMessages } = useChatStream({ onBeforeStart: ..., onReceive: ..., onEnd: ..., startingMessages: [] }) ``` #### startStream `startStream` is a function that starts a stream with the provided arguments and parses the incoming stream into JSON. It takes an object as an argument with the following properties: | Name | Type | Description | | ---- | ------ | ----------- | | url | string | The URL of the stream. | | prompt | string | A string prompt included in the post body on the request to your url. | | ctx | object | Optional context object, sent in the post body on the request to your url. | | method | string | Optional method for the request, one of GET | POST defaults to POST. | | headers | object | Optional request headers | Example: ```jsx startStream({ url: 'http://example.com', prompt: "hey there", ctx: { key: 'value' } }); ``` #### stopStream `stopStream` is a function that stops the stream. It doesn't take any arguments. Example: ```jsx stopStream(); ``` ### useJsonStream `useJsonStream` is a custom React hook that extends the `useStream` hook to add JSON parsing functionality. It uses the `SchemaStream` to parse the incoming stream into JSON. #### Props | Name | Type | Description | | --------- | -------- | ----------- | | onReceive | function | Optional callback function that will be invoked when a JSON object is received. | | onEnd | function | Optional callback function that will be invoked when the JSON stream ends. | | schema | z.ZodObject | The zod schema for the JSON data, the top level must be an object. | | ctx | object | Optional static context object, appended to every post body on each startStream invocation . | | defaultMethod | string | Optional method for the request, one of GET | POST defaults to POST. | | defaultHeaders | object | Optional request headers | #### Usage ```jsx import { useJsonStream } from '@hackdance/hooks'; const { loading, startStream, stopStream, json } = useJsonStream({ onBeforeStart: ..., onReceive: ..., onStop: ..., onEnd: ..., schema: ..., ctx: {} }); ``` #### startStream `startStream` is a function that starts a stream with the provided arguments and parses the incoming stream into JSON. It takes an object as an argument with the following properties: | Name | Type | Description | | ---- | ------ | ----------- | | url | string | The URL of the stream. | | ctx | object | Optional context object, sent in the post body to your url. | | method | string | Optional method for the request, one of GET | POST defaults to POST. | | headers | object | Optional request headers | Example: ```jsx startStream({ url: 'http://example.com', ctx: { key: 'value' } }); ``` #### stopStream `stopStream` is a function that stops the stream. It doesn't take any arguments. Example: ```jsx stopStream(); ``` ## License MIT --- _Source: https://npm.io/package/@hackdance/hooks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._