- Notifications
You must be signed in to change notification settings - Fork78
JS / Browser Client - Build Chat with GetStream.io
License
GetStream/stream-chat-js
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Official JavaScript SDK forStream Chat
Official JavaScript API client for Stream Chat, a service for building chat applications.
Explore the docs »
Report Bug ·Request Feature
You can sign up for a Stream account at ourGet Started page.
This library can be used by both frontend and backend applications. For frontend, we have frameworks that are based on this library such as theFlutter,React andAngular SDKs. For more information, check out ourdocs.
npm install stream-chat
yarn add stream-chat
<scriptsrc="https://cdn.jsdelivr.net/npm/stream-chat"></script>
The StreamChat client is setup to allow extension of the base types through use of generics when instantiated. The default instantiation has all generics set toRecord<string, unknown>.
import{StreamChat}from'stream-chat';// Or if you are on commonjsconstStreamChat=require('stream-chat').StreamChat;constclient=StreamChat.getInstance('YOUR_API_KEY','API_KEY_SECRET');constchannel=client.channel('messaging','TestChannel');awaitchannel.create();
Or you can customize the generics:
typeChatChannel={image:string;category?:string};typeChatUser1={nickname:string;age:number;admin?:boolean};typeChatUser2={nickname:string;avatar?:string};typeUserMessage={country?:string};typeAdminMessage={priorityLevel:number};typeChatAttachment={originalURL?:string};typeCustomReaction={size?:number};typeChatEvent={quitChannel?:boolean};typeCustomCommands='giphy';typeStreamType={attachmentType:ChatAttachment;channelType:ChatChannel;commandType:CustomCommands;eventType:ChatEvent;messageType:UserMessage|AdminMessage;reactionType:CustomReaction;userType:ChatUser1|ChatUser2;};constclient=StreamChat.getInstance<StreamType>('YOUR_API_KEY','API_KEY_SECRET');// Create channelconstchannel=client.channel('messaging','TestChannel');awaitchannel.create();// Create userawaitclient.upsertUser({id:'vishal-1',name:'Vishal',});// Send messageconst{ message}=awaitchannel.sendMessage({text:`Test message`});// Send reactionawaitchannel.sendReaction(message.id,{type:'love',user:{id:'vishal-1'}});
Custom types provided when initializing the client will carry through to all client returns and provide intellisense to queries.
Connect toStream Chat React Native SDK
Run in the root of this repo
yarn link
Run in the root of one of the example apps (SampleApp/TypeScriptMessaging) in thestream-chat-react-native repo
yarn link stream-chatyarn start
Openmetro.config.js file and set value for watchFolders as
conststreamChatRoot='{{CHANGE_TO_THE_PATH_TO_YOUR_PROJECT}}/stream-chat-js'module.exports={// the rest of the metro config goes here ...watchFolders:[projectRoot].concat(alternateRoots).concat([streamChatRoot]),resolver:{// the other resolver configurations go here ...extraNodeModules:{// the other extra node modules go here ...'stream-chat':streamChatRoot}}};
Make sure to replace{{CHANGE_TO_THE_PATH_TO_YOUR_PROJECT}} with the correct path for thestream-chat-js folder as per your directory structure.
Run in the root of this repo
yarn start
Head over todocs/typescript.md for more examples.
We 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 ourContributor License Agreement (CLA) first. See ourlicense file for more details.
Head over toCONTRIBUTING.md for some development tips.
We've recently closed a$38 million Series B funding round and we keep actively growing.Our 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.
Check out our current openings and apply viaStream's website.
About
JS / Browser Client - Build Chat with GetStream.io