GithubHelp home page GithubHelp logo

fetch-observable's Introduction

fetchObservable()

Observable-based Fetch API that automatically refreshes data and notifies subscribers.

Features

  • Uses the standard Fetch API.
  • Uses Observable syntax from ES Observable proposal.
  • Runs in Node and browsers. (BYO Fetch API and Promises polyfills though)

Installation

	npm install --save fetch-observable

Usage

import fetchObservable from "fetch-observable";

// Creates a single observable for one or multiple URLs.
const liveFeed = fetchObservable(
	"http://example.org/live-feed.json", // <-- URL or array of URLs.
	{
		fetch: fetch,  // <-- Replacable fetch implementation.
		refreshDelay: (iteration) => iteration * 1000, // <-- Callback or just integer ms.
		method: "POST" // <-- Basic Fetch API options.
	}
).map((response) => response.json()); // map() resolves Promises.

// Subscribe-syntax of ES Observables activates the observable.
const subscription1 = liveFeed.subscribe({
	next (response) {
		console.dir(response.json());
	},
	error (error) {
		console.warn(error.stack || error);
	}
});

// Multiple subscriptions allowed. They all get the result.
const subscription2 = liveFeed.subscribe({next () {}});

// Observable can be paused and resumed manually.
liveFeed.pause();
liveFeed.resume();

// Observable will be paused automatically when no subscriptions left.
subscription1.unsubscribe();
subscription2.unsubscribe();

Community

Let's start one together! After you ★Star this project, follow me @Rygu on Twitter.

License

BSD 3-Clause license. Copyright © 2015, Rick Wong. All rights reserved.

fetch-observable's People

Contributors

rickwong avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

evaluation-alex

fetch-observable's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.