Options
All
  • Public
  • Public/Protected
  • All
Menu

ChatKitty Server-Side JS SDK

chatkitty-server-side-sdk-js

ChatKitty: Cloud Chat Platform

ChatKitty helps you build real-time chat without any back-end.

Realtime Chat Demo

The example above was created with ChatKitty. Check it out at demo.chatkitty.com.

NPM Package

Build Status

Features

  • Private chat - Provide secure and encrypted direct messaging to your users.

  • Group chat - Your users can request to join or be invited to group chats.

  • Message threads - Keep conversations organized with message threads.

  • Push notifications - Make sure your users always see their messages.

  • File attachments - Attach images, videos, or any other type of files.

  • Typing indicators - Let your users know when others are typing.

  • Reactions - Users can react to messages with emojis and GIFs.

  • Presence indicators - Let your users know who's online.

  • Delivery and read receipts - See when messages get delivered and read.

  • Link preview generation - Messages with links get rich media previews.

ChatKitty is the first complete chat platform; bringing together everything that's required to build real-time chat into Web and mobile apps. Getting started with ChatKitty is easy and you get:

Reliability

Your user chat sessions remain stable even in the presence of proxies, load balancers and personal firewalls. ChatKitty provides auto reconnection support and offline notifications so your users stay in the loop.

Low Latency

With response times below 100ms, ChatKitty makes sure your users have a smooth and immersive chat experience.

Cross-platform support

You can use ChatKitty across every major browser and device platform. ChatKitty also works great with multi-platform frameworks like React-Native and Ionic.

We've spent a lot of time thinking of the right abstractions and implementing our API to be straightforward and easy to use - making you more productive.

This TypeScript/JavaScript client was auto-generated and utilizes axios. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Installation

Install with NPM

npm install chatkitty-server-side-sdk

Install with Yarn

yarn add chatkitty-server-side-sdk

API Documentation

Please see the documentation for this SDK at https://chatkitty.github.io/chatkitty-server-side-sdk-js/

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Generated using TypeDoc, the 4/6/2021 at 3:57:38 PM