fetchster v1.0.9

Fetchster

Fetch wrapper for easy promise based http requests

Installation

$ npm install fetchster

import Fetchster via require or es6 module loading

require Fetchster = "fetchster"

import Fetchster from "fetchster"

HTTP methods supported - get, post, put, delete, head

additionally Fetchster comes with a utility function that converts an object into a string of query params.

var queryParams = {page: 3, resultsPerPage: 30, sort: "asscending"}
var sample = Fetchster.seralize(queryParams)
console.log(sample) //=> "page=3&resultsPerPage=30&sort=asscending"

Fetchster.seralize(queryParams)

• required OBJECT object containing query params in the format {key: value, otherKey: otherValue}

http methods

GET, HEAD

...

 Fetchster.get('http://someapi.org/posts/3').then((response) => {console.log(response)})

 Fetchster = require('fetchster')

 Fetchster.head('http://someapi.org/posts/3').then((response) => {console.log(response)})

Fetchster.get(url, options, errorHandler)

Fetchster.head(url, options, errorHandler)

• required STRING url - url of api to hit
• optional OBJECT options - contains configuration defaults to {headers: 'Content-Type': 'application/json'}}, see options section for details.
• optional FUNCTION errorHandler - function that requires 1 param of err which contains the error object, if not supplied this defaults to console.error(err)

POST, PUT, DELETE

 ...
 
 var body = {sticks: 3, hipster: "dan"}
 
 Fetchster.post('http://someapi.co/hipsters', body).then((response) => console.log(response)}
 
 var body = {name: "dan", hasDog: true}
 
 Fetchster.put('http://someapi.co/hipsters/1', body).then((response) => console.log(response)}
 
 var body = {name: "dan"}
 
  Fetchster.put('http://someapi.co/hipsters', body).then((response) => console.log(response)}

Fetchster.post(url, data, options, errorHandler)

Fetchster.put(url, data, options, errorHandler)

Fetchster.delete(url,data, options, errorHandler)

• required STRING url - url of api to hit
• required OBJECT data - object that contains all the information you want to send on the post body
• optional OBJECT options - contains configuration defaults to {headers: 'Content-Type': 'application/json'}}, see options section for details.
• optional FUNCTION errorHandler - function that requires 1 param of err which contains the error object, if not supplied this defaults to console.error(err)

Options

{
  headers: //Any headers you want to add to your request, contained within a Headers object or ByteString.
  mode: // The mode you want to use for the request, e.g., cors, no-cors, or same-origin.
  credentails: //The request credentials you want to use for the request: omit, same-origin, or include. To automatically send cookies for the current domain, this option must be provided.
  catche: //The cache mode you want to use for the request: default, no-store, reload, no-cache, force-cache, or only-if-cached.
}

fetch options documentation borrowed from Mozilla Contributors