https://github.com/indatawetrust/react-native-nchan

NPM package for the Javasript React Native for Nchan
https://github.com/indatawetrust/react-native-nchan

Last synced: about 1 month ago
JSON representation

NPM package for the Javasript React Native for Nchan

• Host: GitHub
• URL: https://github.com/indatawetrust/react-native-nchan
• Owner: indatawetrust
• Fork: true (slact/nchan.js)
• Created: 2017-03-09T21:03:16.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-01-30T10:43:07.000Z (almost 5 years ago)
• Last Synced: 2024-11-15T02:12:48.872Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 26.4 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-react-native - react-native-nchan ★3 - Nchan (pub/sub server) module for React Native (Components / Backend)
• awesome-react-native - react-native-nchan ★3 - Nchan (pub/sub server) module for React Native (Components / Backend)
• awesome-react-native - react-native-nchan ★3 - Nchan (pub/sub server) module for React Native (Components / Backend)
• awesome-react-native - react-native-nchan ★3 - Nchan (pub/sub server) module for React Native (Components / Backend)

README

        
# NchanSubscriber.js

A Websocket, EventSource, and Long-Polling wrapper for [Nchan](https://nchan.slact.net)

```js

// CommonJS

import NchanSubscriber from 'react-native-nchan'

//options

let opt = {

  subscriber: 'longpoll', 'eventsource', or 'websocket',

    //or an array of the above indicating subscriber type preference

  reconnect: undefined,

  shared: undefined

}

const sub = new NchanSubscriber(url, opt);

sub.on("message", function(message, message_metadata) {

  // message is a string

  // message_metadata is a hash that may contain 'id' and 'content-type'

});

sub.on('connect', function(evt) {

  //fired when first connected.

});

sub.on('disconnect', function(evt) {

  // when disconnected.

});

sub.on('error', function(error_code or evt, error_description) {

  //error callback

});

sub.reconnect; // should subscriber try to reconnect? true by default.

sub.reconnectTimeout; //how long to wait to reconnect? does not apply to EventSource, which reconnects on its own.

sub.lastMessageId; //last message id. useful for resuming a connection without loss or repetition.

sub.start(); // begin (or resume) subscribing

sub.stop(); // stop subscriber. do not reconnect.

```