Stream-js
stream-js is the official JavaScript client for Stream, a web service for building scalable newsfeeds and activity streams. The full documentation is available on GetStream.io/docs. Note that there is also a higher level Node integration which hooks into your ORM.
Installation
Install from NPM
npm install getstream
Install using bower
bower install getstream
Install by downloading the JS file
Using with React Native
For use with React Native be sure to use webpack as your bundler. For a bootstrap project for React native and webpack see this project
Usage
var stream = ;// Instantiate a new client (server side)client = stream;// Optionally supply the app identifier and an object specifying the data center to useclient = stream;// Instantiate a new client (client side)client = stream;// Find your API keys here https://getstream.io/dashboard/ // Instantiate a feed object server sideuser1 = client;// Instantiate a feed object client side// Generate a feed's token using server side signinguser1 = client; // Get activities from 5 to 10 (slow pagination)user1;// (Recommended & faster) Filter on an id less than a given UUIDuser1; // All API calls are performed asynchronous and return a Promise objectuser1 ; // Create a new activityactivity = 'actor': 1 'verb': 'tweet' 'object': 1 'foreign_id': 'tweet:1';user1;// Create a bit more complex activityactivity = 'actor': 1 'verb': 'run' 'object': 1 'foreign_id': 'run:1' 'course': 'name': 'Golden Gate park' 'distance': 10 'participants': 'Thierry' 'Tommaso' 'started_at': ;user1; // Remove an activity by its iduser1;// or remove by the foreign iduser1; // mark a notification feed as readnotification1 = client;var params = mark_read: true;notification1; // mark a notification feed as seenvar params = mark_seen:true;notification1; // Follow another feeduser1; // Stop following another feeduser1; // Stop following another feed while keeping previously published activities// from that feeduser1; // Follow another feed without copying the historyuser1; // List followers, followinguser1;user1; // all methods support callback as the last argumentuser1; // adding multiple activitiesactivities = 'actor': 1 'verb': 'tweet' 'object': 1 'actor': 2 'verb': 'tweet' 'object': 3;user1; // specifying additional feeds to push the activity to using the to param// especially usefull for notification style feedsto = 'user:2' 'user:3';activity = 'to': to 'actor': 1 'verb': 'tweet' 'object': 1 'foreign_id': 'tweet:1';user1; // adding one activity to multiple feedsvar feeds = 'flat:1' 'flat:2' 'flat:3' 'flat:4';activity = 'actor': 'User:2' 'verb': 'pin' 'object': 'Place:42' 'target': 'Board:1'; client; // Batch create follow relations (let flat:1 follow user:1, user:2 and user:3 feeds in one single request)var follows = 'source': 'flat:1' 'target': 'user:1' 'source': 'flat:1' 'target': 'user:2' 'source': 'flat:1' 'target': 'user:3'; client; // creating a feed token server sidetoken = user1token;// passed to client via template or api and initialized as suchuser1 = client; // creating a read-only feed token server sidereadonlyToken = client;// passed to client via template or api and initialized as suchuser1 = client; // Create redirect urlsvar impression = 'content_list': 'tweet:1' 'tweet:2' 'tweet:3' 'user_data': 'tommaso' 'location': 'email' 'feed_id': 'user:global';var engagement = 'content': 'tweet:2' 'label': 'click' 'position': 1 'user_data': 'tommaso' 'location': 'email' 'feed_id': 'user:global';var events = impression engagement;var redirectUrl = client;
Faye
Stream uses Faye for realtime notifications. Below is quick quide to subcribing to feed changes
var stream = ;// NOTE: the site id is needed for subscribing// server side example:client = stream;user1 = client;// same two lines but client side (generate the feed token server side)client = stream;user1 = client;// subscribe to the changesvar subscription = user1;// now whenever something changes to the feed user 1// the callback will be called // To cancel a subscription you can call cancel on the// object returned from a subscribe call.// This will remove the listener from this channel.subscription;
Docs are available on GetStream.io.
Contributing
First, make sure you can run the test suite. Tests are run via Mocha
mocha test/integration/index.js test/unit/index.js# browser version (needs to be build through gulp build:test) test/browser/test.html# coverage mocha test/cov.js -R html-cov > cov.html
Releasing
Make sure your working directory is clean. And run:
npm installnpm version [ major | minor | patch ]npm publish