Giter Club home page Giter Club logo

node-superfeedr's Introduction

Modules

superfeedr

node-superfeedr

Install:

npm install node-superfeedr

Example:

var superfeedr = require('node-superfeedr');
superfeedr/subscribers/http

Superfeedr Subscribers Http Client

Example:

var superfeedr = require('node-superfeedr');
var options = {
  username: process.env.SUPERFEEDR_USERNAME || 'username',
  token: process.env.SUPERFEEDR_TOKEN || 'token'
};

var client = new superfeedr.Subscribers.HttpClient(options);

superfeedr

node-superfeedr

Install:

npm install node-superfeedr

Example:

var superfeedr = require('node-superfeedr');

superfeedr/subscribers/http

Superfeedr Subscribers Http Client

Example:

var superfeedr = require('node-superfeedr');
var options = {
  username: process.env.SUPERFEEDR_USERNAME || 'username',
  token: process.env.SUPERFEEDR_TOKEN || 'token'
};

var client = new superfeedr.Subscribers.HttpClient(options);

Submodule: http

Param Type Description
[options] Object override default options
options.username string Superfeedr username
options.token string Superfeedr token value
options.endpoint url Superfeedr Push Api Endpoint

superfeedr/subscribers/http~addFeed(topic, callback, [secret], [options]) ⇒ Promise

Kind: inner method of superfeedr/subscribers/http

Param Type Description
topic url The URL of the HTTP resource to which you want to subscribe. It cannot be more than 2048 characters long.
callback url The webhook: it's the URL to which notifications will be sent. Make sure you it's web-accessible, ie not behind a firewall. Its size is currently limited to 250 characters.
[secret] string Recommended. A unique secret string which will be used by us to compute a signature. You should check this signature when getting notifications.
[options] Object Less used options
options.verify string Will perform a PubSubHubbub verification of intent synschronously or asynschronously
options.format string If you want to receive notifications as json format (for feeds only!). You can also use an Accept HTTP header like this: Accept: application/json. If you explicitly want to receive notification as Atom. This is used by default for any resource that's either Atom or RSS. If you don't specify any, we will send you the data pulled from the HTTP resource, (excluding feeds).
options.retrieve string If set to true, the response will include the current representation of the feed as stored in Superfeedr, in the format desired. Please check our Schema for more details.

superfeedr/subscribers/http~removeFeed(topic, [callback], [options]) ⇒ Promise

Kind: inner method of superfeedr/subscribers/http

Param Type Description
topic url The URL of the HTTP resource to which you want to unsubscribe.
[callback] url The URL to which notifications will be sent. It is optional if you are only subscribed to the feed 'once', with a single hub.callback. If you have multiple subscriptions, you will need to supply the hub.callback parameter. It is also required if you use the hub.verify param.
[options] Object Less used options
options.verify string We will perform a PubSubHubbub verification of intent synschronously or asynschronously.

node-superfeedr's People

Contributors

dreadjr avatar

Watchers

 avatar

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.