pub-src-http

1.2.1 • Public • Published

pub-src-http

CI

HTTP source for pub-server and pub-generator

  • provides get() and put() for JSON reads and writes over http
  • uses node-fetch in node, built-in fetch in browser

src(options)

var src = require('pub-src-http');

// instantiate source
// options become properties of source
var source = src( { path:'https://....' } );

source.get(function(err, result) {
  if (err) return console.log(err);
  console.log(result);
});

source.path

  • must be set to the URL of the HTTP endpoint

source.timeout

  • not currently implemented

source.get([options], cb)

  • get() fetches JSON in a single HTTP GET request from the endpoint in source.path
  • the result should be an array of file objects each with a path: and a text: property
  • for non "PUB" type sources, other JSON structures may be retrieved

source.put(files, [options], cb)

  • does nothing unless writable is set on the source
  • serializes files into JSON and transmits them via HTTP POST to the endpoint in source.path

options

  • use optional options object for fetch options like headers
  • use options.url to override endpoint
source.put(files, function(err, result) {
  if (err) return console.log(err);
  console.log(result);
});

configuring authentication

  • explicit authentication configuration is not currently supported
  • in the browser request cookie credentials are included

Readme

Keywords

none

Package Sidebar

Install

npm i pub-src-http

Weekly Downloads

7

Version

1.2.1

License

MIT

Unpacked Size

5.13 kB

Total Files

4

Last publish

Collaborators

  • jldec