npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

realtime-rest

v0.2.0

Published

A small long-polling client provided with the django-realtime-rest package.

Downloads

3

Readme

Small long-polling client

This tool, provided with the django-realtime-rest, can be used to easily link a model (a simple javascript object) to data fed by the server through the use of a long-polling call.

Usage

To try it in node.js, just create an RTView object and then call monitor:

var realtime_rest = require('realtime_rest');
const rtView = realtime_rest.RTView('localhost:8000/api/my-models-rt/', function (data) {
  console.log(data);
}, realtime_rest.nodeGet);
rtView.monitor();

If you work with angular, RTView can take a third parameter which will be the function used to perform the HTTP GET call:

const rtView = RTView('/api/my-models-rt/', function (data) {
  $scope.evalAsynch(function () {
    // Do something with the data, which is a Javascript object
  });
}, $http.get);
rtView.monitor();

Get function

/!\ Note that by default, realtime_rest will use the XMLHttpRequest browser function to perform the get request. If you use the tool on node, use the node compatible function nodeGet. You can also provide you own implementation of get which shall follow the following specifications:

  1. It shall take a url as string
  2. It shall return a ES6 promise which resolve an object containing a data field which points to a JSON object:
{
  data: '[{"myField": "foo"}]',
}
  1. It shall reject in case of error with an object like:
{
  status: <status code>,
  message: <error message>,
}

angular's $http.get satisfies those requirements.