happy-request v0.0.1

Happy Request

HTTP request agent base on XMLHttpRequest and fetch.

Features

• Provide Friendly APIs for sending request
• Manage HTTP request definitions of backend service

Basic usage

import {HappyRequest} from 'happy-request/request';

// create a request instance
const req = new HappyRequest(optiont: HappyRequestOptions);

// set success callback
req.success((res: HappyResponse) => {});

// set error callback
req.error((e) => {});

// set exception handler
req.catch((e) => {});

HappyRequest's constructor parameters

HappyRequestOptions definition

HappyResponse

HappyRequest's methods

• send(): HappyRequest Send request manually
• cancel(): HappyRequest Cancel request
• success(cb: (res: HappyResponse) => any): HappyRequest Set success callback
• error(cb: (res: HappyResponse) => any): HappyRequest Set error callback
• finally(cb: () => any): HappyRequest Set finally callback
• catch(cb: (e: Error) => any): HappyRequest Set exception handler
• beforeRequest(cb: () => any): HappyRequest Set interceptor before request
• afterResponse(cb: (res: HappyResponse) => any): HappyRequest Set interceptor after response. Returning false means stop to call success/error/finally callbacks

Advance usage

import {HappyAPIManager} from 'happy-request';

// API definitions
const apis: Array<HappyAPI> = [
    {
        token: 'user.create',
        url: '/user',
        method: 'POST',
        body: ['username']// form fields
    },
    {
        token: 'user.list',
        url: '/user',
        method: 'GET',
        query: ['page', 'pageSize', 'username']// url query parameters
    },
    {
        token: 'user.detail',
        url: '/user/:uid',
        method: 'GET',
        responseType: 'json'// do not need to specify "json" while response's header "Content-Type" equal "application/json"
    },
    {
        token: 'user.delete',
        url: '/user/:uid',
        method: 'DELETE'
    }
];

// create a API manager instance
const am = new HappyAPIManager(apis, env.isDev /* validate api format in develop enviroment */);

// create a user
am.post('user.create', {username: 'happy'})
    .success(() => {
        alert('Create user successfully');
    })
    .error(() => {
        alert('Fail to create user');
    });

// user list
am.get('user.list', {username: 'happy'})
    .success((data) => {
        // show user list
    });

// user detail
am.request({
    token: 'user.detail',
    path: {uid: 1}
}).success(() => {});

// delete user
am.request({
    token: 'user.delete',
    path: {uid: 1}
}).success(() => {});

API definition

HappyAPIManager constructor parameters

HappyAPIManager's methods

• add(api: HappyAPI, check: boolean): HappyAPIManager Add api definition
• beforeRequest(cb: () => any): HappyAPIManager Set interceptor before sending request for all APIs
• afterResponse(cb: (res: HappyResponse) => any): HappyAPIManager Set interceptor after response for all APIs
• request(params: HappyAPIRequestParams, sendImmediately: boolean = true): HappyRequest Create a request instance
• get(token: Token, query: PlainParams | undefined | null, sendImmediately: boolean = true): HappyRequest Syntactic sugar for GET request
• post(token: Token, body: any, query: PlainParams | undefined | null, sendImmediately: boolean = true): HappyRequest Syntactic sugar for POST request
• put(token: Token, body: any, query: PlainParams | undefined | null, sendImmediately: boolean = true): HappyRequest Syntactic sugar for PUT request
• patch(token: Token, body: any, query: PlainParams | undefined | null, sendImmediately: boolean = true): HappyRequest Syntactic sugar for PATCH request
• delete(token: Token, query: PlainParams | undefined | null, sendImmediately: boolean = true): HappyRequest Syntactic sugar for DELETE request
• getURL(token: Token, query: PlainParams | null | undefined, path: PlainParams | null | undefined): string Generate url