https://github.com/inpassor/centrifuge-ts

Browser Javascript client for Centrifugo (TypeScript edition)
https://github.com/inpassor/centrifuge-ts

centrifuge centrifugo sockjs typescript websocket

Last synced: 2 months ago
JSON representation

Browser Javascript client for Centrifugo (TypeScript edition)

• Host: GitHub
• URL: https://github.com/inpassor/centrifuge-ts
• Owner: Inpassor
• License: mit
• Created: 2018-01-24T16:31:32.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-26T09:45:08.000Z (over 5 years ago)
• Last Synced: 2024-11-10T23:38:24.908Z (2 months ago)
• Topics: centrifuge, centrifugo, sockjs, typescript, websocket
• Language: TypeScript
• Homepage:
• Size: 494 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Browser Javascript client for Centrifugo

See client [documentation](https://fzambia.gitbooks.io/centrifugal/content/clients/javascript.html)

## Install

You can clone the repository or use NPM package `centrifuge-ts`.

## Development

It is convenient to make changes to the `centrifuge-ts` code by running the command

`npm run watch`.

## Contribute

If you want to contribute, install dependencies and run `npm run build` command from

the root repo folder - this results in creating unminified (`centrifuge.js`) and

minified (`centrifuge.min.js`) bundles in `dist` directory.

## Example

~~~

import {

    Centrifuge,

    Subscription,

} from 'centrifuge-ts';

const centrifuge = new Centrifuge({

    // centrifuge options

});

~~~