Class ServiceProvider`Abstract`

Index

Constructors

Methods

_createURL _getApp _getBase _getDomain _getPort _getProtocol delete get getApp getVersion post put request urlSuffix

Constructors

constructor

new ServiceProvider(app: Application): ServiceProvider
Parameters
- app: Application
Returns ServiceProvider
- Defined in src/ServiceProvider.ts:29

Methods

`Protected`_createURL

_createURL(url: string, queryParams?: Record<any, any>): string
Parameters
- url: string
- OptionalqueryParams: Record<any, any>
Returns string
- Defined in src/ServiceProvider.ts:64

`Protected`_getApp

_getApp(): Application
Returns Application
- Defined in src/ServiceProvider.ts:36

`Protected` `Abstract`_getBase

_getBase(): string
Returns string
- Defined in src/ServiceProvider.ts:33

`Protected`_getDomain

_getDomain(): string
Returns string
- Defined in src/ServiceProvider.ts:44

`Protected` `Abstract`_getPort

_getPort(): number
Returns number
- Defined in src/ServiceProvider.ts:34

`Protected`_getProtocol

_getProtocol(): string
Returns string
- Defined in src/ServiceProvider.ts:56

delete

delete(
    url: string,
    accessToken: string,
    data?: any,
    headers?: IServiceHeaders,
    additionalOptions?: any,
): Promise<ServiceResponse>
Parameters
- url: string
- accessToken: string
- Optionaldata: any
- Optionalheaders: IServiceHeaders
- OptionaladditionalOptions: any
Returns Promise<ServiceResponse>
- Defined in src/ServiceProvider.ts:152

get

get(
    url: string,
    accessToken: string,
    data?: any,
    headers?: IServiceHeaders,
    additionalOptions?: any,
): Promise<ServiceResponse>
Parameters
- url: string
- accessToken: string
- Optionaldata: any
- Optionalheaders: IServiceHeaders
- OptionaladditionalOptions: any
Returns Promise<ServiceResponse>
- Defined in src/ServiceProvider.ts:140

getApp

getApp(): Application
Returns Application
- Defined in src/ServiceProvider.ts:40

getVersion

getVersion(): string
Returns string
- Defined in src/ServiceProvider.ts:60

post

post(
    url: string,
    accessToken: string,
    data?: any,
    headers?: IServiceHeaders,
    additionalOptions?: any,
): Promise<ServiceResponse>
Parameters
- url: string
- accessToken: string
- Optionaldata: any
- Optionalheaders: IServiceHeaders
- OptionaladditionalOptions: any
Returns Promise<ServiceResponse>
- Defined in src/ServiceProvider.ts:144

put

put(
    url: string,
    accessToken: string,
    data?: any,
    headers?: IServiceHeaders,
    additionalOptions?: any,
): Promise<ServiceResponse>
Parameters
- url: string
- accessToken: string
- Optionaldata: any
- Optionalheaders: IServiceHeaders
- OptionaladditionalOptions: any
Returns Promise<ServiceResponse>
- Defined in src/ServiceProvider.ts:148

request

request(
    method: HTTPMethod,
    url: string,
    accessToken: string,
    data: any,
    headers?: IServiceHeaders,
    additionalOptions?: any,
): Promise<ServiceResponse>
Parameters
- method: HTTPMethod
- url: string
- accessToken: string
- data: any
- Optionalheaders: IServiceHeaders
- OptionaladditionalOptions: any
Returns Promise<ServiceResponse>
- Defined in src/ServiceProvider.ts:81

urlSuffix

urlSuffix(): string
Returns string
- Defined in src/ServiceProvider.ts:52