https://github.com/hildjj/node-feedly

Node API for Feedly
https://github.com/hildjj/node-feedly

Last synced: 19 days ago
JSON representation

Node API for Feedly

• Host: GitHub
• URL: https://github.com/hildjj/node-feedly
• Owner: hildjj
• License: mit
• Created: 2014-05-04T22:56:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T20:47:44.000Z (almost 5 years ago)
• Last Synced: 2024-10-18T20:35:45.031Z (28 days ago)
• Language: JavaScript
• Size: 822 KB
• Stars: 122
• Watchers: 5
• Forks: 23
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-list - node-feedly

README

        
This is a node API for [Feedly](http://developer.feedly.com)

Installation

============

Install from NPM:

    npm install --save feedly

Creating an instance

====================

Create an instance:

    const Feedly = require('feedly')

    const f = new Feedly({

      client_id: 'MY_CLIENT_ID',

      client_secret: 'MY_CLIENT_SECRET',

      port: 8080

    })

Use the sandbox:

    const Feedly = require('feedly')

    const f = new Feedly({

      client_id: 'sandbox',

      client_secret: 'Get the current secret from http://developer.feedly.com/v3/sandbox/',

      base: 'http://sandbox.feedly.com',

      port: 8080

    })

Authentication

==============

The first non-trivial method call you make to the object will cause your

default browser to pop up asking you to log in.  When that process is complete,

you will see a page served from http://localhost:8080/, which you can close.

After that point, you won't need to log in again until your token expires

(without your having called `refresh` in the meantime).

**WARNING**: by default, this will store your auth token and refresh token in  

`~/.feedly`, unencrypted.  Set the `config_file` options to null to prevent this

behavior, but you will have to log in through the web site each time you create

a new `Feedly` instance.

Callbacks and promises

======================

Each method takes an optional node-style `(error, results)` callback.  If you

prefer a promise-style approach, you do without a callback, like this:

    const results = await f.reads()

Documentation

=============

Full documentation for the API can be found

[here](http://hildjj.github.io/node-feedly/doc/).