8.1.9 • Published 5 months ago

@appolo/http v8.1.9

Weekly downloads
143
License
MIT
Repository
github
Last release
5 months ago

Http Service module for appolo build with axios

Installation

npm i @appolo/http

in config/modules/all.ts

Options

keyDescriptionTypeDefault
idhttpService injection idstringhttpService

any option from Request Config can be added and will be added to all request.

import {HttpModule} from '@appolo/http';

export = async function (app: App) {
   await app.module(new HttpModule({baseURL:"https://some-domain.com/api/",retry:2}));
}

Usage

import {define, singleton,inject} from 'appolo'
import {publisher} from "@appolo/http";

@define()
@singleton()
export class SomeManager {

    @inject httpService:HttpService

    async getUserId(): Promise<string> {

        let result = await this.httpService.request<{userId:string}>({
            url:"http://someurl"
            method:"post"
            timeout:1000
            retry:3
        })

        return result.data.userId
    }
}

Request Config

keyDescriptionTypeDefault
urlrequest url |string`|
methodis the request method to be used when making the requeststringget
baseURLbaseURL will be prepended to url unless url is absolutestring
headerscustom headersobject{}
paramsare the URL parameters to be sent with the requestobject{}
datathe data to be sent as the request bodyobject{}
timeoutspecifies the number of milliseconds before the request times outnumber0
withCredentialsindicates whether or not cross-site Access-Control requestsbooleanfalse
authindicates that HTTP Basic auth should be used, and supplies credentialsobject{}
authDigestindicates that HTTP Digest Auth should be used, and supplies credentialsobject{}
responseTypeindicates the type of data that the server will respond withstringjson
responseEncodingindicates encoding to use for decoding responsesstringutf8
maxRedirectsdefines the maximum number of redirects to follow in node.jsnumber5
retryretry times on requests that return a response (500, etc) before giving upnumber0
noResponseRetriesetry times on errors that don't return a response (ENOTFOUND, ETIMEDOUT, etc)number0
retryDelayMilliseconds to delay at firstnumber100
8.1.8

5 months ago

8.1.9

5 months ago

8.1.7

5 months ago

8.1.6

5 months ago

8.1.4

6 months ago

8.1.5

5 months ago

8.1.3

10 months ago

8.1.2

11 months ago

8.1.1

11 months ago

8.1.0

12 months ago

8.0.2

2 years ago

8.0.1

3 years ago

8.0.0

3 years ago

7.0.9

4 years ago

7.0.10

4 years ago

7.0.8

4 years ago

7.0.7

4 years ago

7.0.6

4 years ago

7.0.5

4 years ago

7.0.4

4 years ago

7.0.3

4 years ago

7.0.2

4 years ago

7.0.1

4 years ago

7.0.0

4 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago