mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2025-03-14 09:45:42 +00:00
621b291da1
* core: member mentions, types and rfc * update * update rfc * save/get mentions (WIP) * markdown * store received mentions and userMention flag * sent mentions * update message with mentions * db queries * CLI mentions, test passes * use maps for mentions * tests * comment * save mentions on sent messages * postresql schema * refactor * M.empty * include both displayName and localAlias into MentionedMemberInfo * fix saving sent mentions * include mentions in previews * update plans |
||
|---|---|---|
| .. | ||
| examples | ||
| src | ||
| tests | ||
| .eslintrc.yml | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| copy | ||
| jest.config.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
SimpleX Chat JavaScript client
This is a TypeScript library that defines WebSocket API client for SimpleX Chat terminal CLI that should be run as a WebSockets server on any port:
simplex-chat -p 5225
Client API provides types and functions to:
- create and change user profile (although, in most cases you can do it manually, via SimpleX Chat terminal app).
- create and accept invitations or connect with the contacts.
- create and manage long-term user address, accepting connection requests automatically.
- create, join and manage group.
- send and receive files.
Use cases
- chat bots: you can implement any logic of connecting with and communicating with SimpleX Chat users. Using chat groups a chat bot can connect SimleX Chat users with each other.
- control of the equipment: e.g. servers or home automation. SimpleX Chat provides secure and authorised connections, so this is more secure than using rest APIs.
Please share your use cases and implementations.
Quick start
npm i simplex-chat
npm run build
See the example of a simple chat bot in squaring-bot.js:
- start
simplex-chatas a server on port 5225:simplex-chat -p 5225 -d test_db - run chatbot:
node examples/squaring-bot - connect to chatbot via SimpleX Chat client using the address of the chat bot
Documentation
Please refer to the available client API in client.ts.