tinode-sdk

0.23.0-rc1 • Public • Published

Javascript bindings for Tinode

This SDK implements Tinode client-side protocol for the browser based applications. See it in action at https://web.tinode.co/ and https://sandbox.tinode.co/ (full source).

This is not a standalone project. It can only be used in conjunction with the Tinode server.

Regularly released NPM packages are at https://www.npmjs.com/package/tinode-sdk

You may include the latest standalone minified SDK into your html file as

<script crossorigin="anonymous"
  src="https://cdn.jsdelivr.net/npm/tinode-sdk/umd/tinode.prod.js">
</script>

or while developing as

<script crossorigin="anonymous"
  src="https://cdn.jsdelivr.net/npm/tinode-sdk/umd/tinode.dev.js">
</script>

Getting support

Helping out

  • If you appreciate our work, please help spread the word! Sharing on Reddit, HN, and other communities helps more than you think.
  • Consider buying paid support: https://tinode.co/support.html
  • If you are a software developer, send us your pull requests with bug fixes and new features.
  • If you use the SDK and discover bugs or missing features, let us know by filing bug reports and feature requests. Vote for existing feature requests you find most valuable.

Node JS compatibility

This SDK is intended to be used in a browser. To use tinode-sdk in Node JS environment (such as on a server), you have to polyfill network providers, for example with ws and xmlhttprequest or xhr, as well as indexedDB with something like fake-indexeddb:

  Tinode.setNetworkProviders(require('ws'), require('xmlhttprequest'));
  Tinode.setDatabaseProvider(require('fake-indexeddb'));
  this.tinode = new Tinode(...);

URL.createObjectURL() and related methods were added in Node v16.7.0. The SDK is unlikely to work correctly with earlier versions of Node.

Package Sidebar

Install

npm i tinode-sdk

Weekly Downloads

168

Version

0.23.0-rc1

License

Apache-2.0

Unpacked Size

1.25 MB

Total Files

7

Last publish

Collaborators

  • or-else