reading-data-instapaper

Members

(inner) config :Object

Configuration object providing a default configuration to be used by ReadingData#use()

Properties:
Name Type Default Description
scope String 'instapaper'

The scope this plugin’s data should be saved under on the ReadingData instance.
limit Number 5

The maximum number of bookmarks to request from the Instapaper API.
folder_id String 'archive'

The folder to request from the Instapaper API.
apiVersion Number 1.1

The version of the Instapaper API that should be queried.
fetchText Boolean false

Whether or not to try to retrieve a bookmark’s full text.
useCache Boolean false

Whether or not to use cached/preloaded data.
Source:
Type:
  • Object

Methods

(inner) data(pluginContext, context) → {Object}

Create a client for the Instapaper API and request a collection of bookmarks.

Source:
Parameters:
Name Type Description
pluginContext Object

Context variables specific to this plugin.

Name Type Description
config Object

This plugin’s configuration.
data Object

Any data already stored by ReadingData under this plugin’s scope.
context Object

Contextual this passed from the ReadingData calling environment. Equivalent to the entire ReadingData instance.

Name Type Description
config Object

Global configuration settings.
data Object

Data stored on the ReadingData instance.
Returns:
Type:
Object

Data to be stored by ReadingData under this plugin’s scope.