Skip to content
This repository has been archived by the owner on Dec 29, 2021. It is now read-only.

neelkamath/omni-chat-js

Repository files navigation

Omni Chat JS

npm (scoped)

Omni Chat API JavaScript wrapper library.

  • Platforms: Browsers supporting ES6 or higher
  • Module systems: ECMAScript Modules
  • Programming languages: ES6 (JavaScript, TypeScript, etc. which target ES6 or higher)
  • Static types: TypeScript definitions bundled

Installation

This table shows which versions of Omni Chat JS support which versions of Omni Chat Backend:

Omni Chat JS Omni Chat Backend
3.0.0 or higher 0.24.0 or higher
2.0.0 - 2.0.1 0.23.0
0.12.0 - 1.0.0 0.19.0 - 0.22.0
0.11.0 0.18.0
0.8.0 - 0.10.0 0.17.0
0.5.0 - 0.7.0 0.16.0
0.1.0 - 0.4.0 0.15.0
npm i @neelkamath/omni-chat

Usage

  • Here's the latest version's documentation. To view a previous version's documentation, find the relevant release, download docs.zip from Assets, unzip it, and open docs/index.html in your browser.

  • Changelog

  • Never import APIs from nested files.

    For example, this is correct:

    import { RestApi } from '@neelkamath/omni-chat';

    For example, this is incorrect:

    import { getMediaMessage } from '@neelkamath/omni-chat/dist/restApi/operator';

License

This project is under the MIT License.