zoyi-simple-fetch v0.1.19

simple-fetch

Simple, easy to use fetch wrapping module

Installation

npm install zoyi-simple-fetch

Testing

npm test

Building

npm run build

Usage

// Require
var sf = require('zoyi-simple-fetch')

// Create instance
var client = new sf.Client()

Features

Set base url depending on NODE_ENV

// Set base url
client.setBaseUrl('http://base.url')

// Set base url depending on NODE_ENV
client.setBaseUrl({
    staging: 'http://dev.base.url',  // if NODE_ENV is 'staging'
    production: 'http://base.url'    // if NODE_ENV is 'production'
})

Set default header which is applied to every request

client.setDefaultHeader({
    'Accept': 'application/json',
    'Content-Type': 'application/json'
})

Set header interceptor (filter) for dynamic header

client.setHeaderInterceptor((header) => {
    // header is defaultHeader
    header['X-Auth-Token'] = 'ABCD'
    return header
})

Set credential options

// default value is '' (means no use)
client.credentials = ''

// Use cookies for same origin
client.credentials = 'same-origin'

// For CORS
client.credentials = 'include'

Encode query string on GET method

const query = { key: 'value' }
client.get('url', query)

Encode request body to json on POST, PUT method

const body = { key: 'value' }
client.post('url', body)
client.put('url', body)

Encode request body to url encoded form on POST, PUT method

const body = { key: 'value' }
client.postByUrlEncoding('url', body)
client.putByUrlEncoding('url', body)

No encode on DELETE method

client.delete('url')

Decode response body to json

client.get('url').then((body: JSON) => {
    console.log(body)
})

Reject if status code is not 2XX

client.get('url').then(() => {}).catch((err: Error) => {
    console.error(err)
})

// Error type is below.
interface Error {
    status: string;     // status code
    statusText: string; // status text
    body: JSON;         // json decoded response body
}

Throw status code 0 if internet is disconnected (Actually, not reachable to server)

// Tested in Safari, Chrome, IE10, IE11, Edge
{
    status: 0,
    statusText: 'TypeError ~~'
}

To Do

• Abstract file upload and Support uploading progress