\n\n## ๐ About Stream\n\nYou can sign up for a Stream account at our [Get Started](https://getstream.io/chat/get_started/) page.\n\nThis library can be used by both frontend and backend applications. For frontend, we have frameworks that are based on this library such as the [Flutter](https://github.com/GetStream/stream-chat-flutter), [React](https://github.com/GetStream/stream-chat-react) and [Angular](https://github.com/GetStream/stream-chat-angular) SDKs. For more information, check out our [documentation](https://getstream.io/chat/docs/).\n\n## โ๏ธ Installation\n\n### NPM\n\n```bash\nnpm install stream-chat\n```\n\n### Yarn\n\n```bash\nyarn add stream-chat\n```\n\n## โจ Getting Started\n\n```ts\nimport { StreamChat } from 'stream-chat';\n// or if you are using CommonJS\nconst { StreamChat } = require('stream-chat');\n\nconst client = new StreamChat('API_KEY', 'API_SECRET', {\n disableCache: true, // recommended option for server-side use\n // ...other options like `baseURL`...\n});\n\n// create a user\nawait client.upsertUser({\n id: 'vishal-1',\n name: 'Vishal',\n});\n\n// create a channel\nconst channel = client.channel('messaging', 'test-channel', {\n created_by_id: 'vishal-1',\n});\nawait channel.create();\n\n// send message\nconst { message } = await channel.sendMessage({ text: 'This is a test message' });\n\n// send reaction\nawait channel.sendReaction(message.id, { type: 'love', user: { id: 'vishal-1' } });\n```\n\nThe `StreamChat` client is set up to allow extension of the base types through use of module augmentation, custom types will carry through to all client returns and provide code-completion to queries (if supported). To extend Stream's entities with custom data you'll have to create a declaration file and make sure it's loaded by TypeScript, [see the list of extendable interfaces](https://github.com/GetStream/stream-chat-js/blob/master/src/custom_types.ts) and the example bellow using two of the most common ones:\n\n```ts\n// stream-custom-data.d.ts\n\nimport 'stream-chat';\n\ndeclare module 'stream-chat' {\n interface CustomMessageData {\n custom_property?: number;\n }\n interface CustomUserData {\n profile_picture?: string;\n }\n}\n\n// index.ts\n\n// property `profile_picture` is code-completed and expects type `string | undefined`\nawait client.partialUpdateUser({\n id: 'vishal-1',\n set: { profile_picture: 'https://random.picture/1.jpg' },\n});\n\n// property `custom_property` is code-completed and expects type `number | undefined`\nconst { message } = await channel.sendMessage({\n text: 'This is another test message',\n custom_property: 255,\n});\n\nmessage.custom_property; // in the response object as well\n```\n\n> [!WARNING] \n> Generics mechanism has been removed in version `9.0.0` in favour of the module augmentation, please see [the release guide](https://getstream.io/chat/docs/node/upgrade-stream-chat-to-v9) on how to migrate.\n\n## ๐ (Optional) Development Setup in Combination With Our SDKs\n\n### Connect to [Stream Chat React Native SDK](https://github.com/GetStream/stream-chat-react-native)\n\nRun in the root of this repository:\n\n```sh\nyarn link\n```\n\nRun in the root of one of the example applications (SampleApp/TypeScriptMessaging) in the `stream-chat-react-native` repository:\n\n```sh\nyarn link stream-chat\nyarn start\n```\n\nOpen `metro.config.js` file and set value for `watchFolders` as:\n\n```js\nconst streamChatRoot = '/stream-chat-js'\n\nmodule.exports = {\n // the rest of the metro configuration goes here\n ...\n watchFolders: [projectRoot].concat(alternateRoots).concat([streamChatRoot]),\n resolver: {\n // the other resolver configurations go here\n ...\n extraNodeModules: {\n // the other extra node modules go here\n ...\n 'stream-chat': streamChatRoot\n }\n }\n};\n```\n\nMake sure to replace `` with the correct path for the `stream-chat-js` folder as per your directory structure.\n\nRun in the root of this repository:\n\n```sh\nyarn start\n```\n\n## ๐ More Code Examples\n\nRead up more on [Logging](./docs/logging.md), [User Token](./docs/userToken.md), and [Webhooks](./docs/webhooks.md) (including compressed payloads and SQS / SNS delivery) or visit our [documentation](https://getstream.io/chat/docs/) for more examples.\n\n## โ๏ธ Contributing\n\nWe welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our [license file](./LICENSE) for more details.\n\nHead over to [CONTRIBUTING.md](./CONTRIBUTING.md) for some development tips.\n\n## ๐งโ๐ป We Are Hiring!\n\nWe've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.\nOur APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.\n\nCheck out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).\n","readmeFilename":"README.md"}
![](\"./assets/logo.svg\"){kind=logo}
\n