Class ApiServiceInstance

Hierarchy (view full)

RWSService
- ApiServiceInstance

Index

Constructors

Properties

_RELOADABLE back config token? _DEFAULT _IN_CLIENT

Methods

addHeader connectToAmplify delete get getBackendUrl getHeaders getSingleton isDefault isGetTargetReachable isInClient post pureGet put register setToken uploadFile getSingleton register

Constructors

constructor

new ApiServiceInstance(config): ApiServiceInstance
Parameters
- config: ConfigServiceInstance
Returns ApiServiceInstance
Overrides RWSService.constructor
- Defined in src/services/ApiService.ts:42

Properties

_RELOADABLE

_RELOADABLE: boolean = false

back

back: {
    delete: (<T>(routeName, options?) => Promise<T>);
    get: (<T>(routeName, options?) => Promise<T>);
    post: (<T, P>(routeName, payload?, options?) => Promise<T>);
    put: (<T, P>(routeName, payload, options?) => Promise<T>);
    uploadFile: ((routeName, file, onProgress, options?, payload?) => Promise<UploadResponse>);
} = ...

Type declaration

delete: (<T>(routeName, options?) => Promise<T>)
- - <T>(routeName, options?): Promise<T>
  - Type Parameters
    - T
    Parameters
    - routeName: string
    - Optional options: IAPIOptions
    Returns Promise<T>
get: (<T>(routeName, options?) => Promise<T>)
- - <T>(routeName, options?): Promise<T>
  - Type Parameters
    - T
    Parameters
    - routeName: string
    - Optional options: IAPIOptions
    Returns Promise<T>
post: (<T, P>(routeName, payload?, options?) => Promise<T>)
- - <T, P>(routeName, payload?, options?): Promise<T>
  - Type Parameters
    - T
    - P extends object = object
    Parameters
    - routeName: string
    - Optional payload: P
    - Optional options: IAPIOptions
    Returns Promise<T>
put: (<T, P>(routeName, payload, options?) => Promise<T>)
- - <T, P>(routeName, payload, options?): Promise<T>
  - Type Parameters
    - T
    - P extends object = object
    Parameters
    - routeName: string
    - payload: P
    - Optional options: IAPIOptions
    Returns Promise<T>
uploadFile: ((routeName, file, onProgress, options?, payload?) => Promise<UploadResponse>)
- - (routeName, file, onProgress, options?, payload?): Promise<UploadResponse>
  - Parameters
    - routeName: string
    - file: File
    - onProgress: ((progress) => void)
      (progress): void
      Parameters
      progress: number
      Returns void
    - options: IAPIOptions = {}
    - payload: any = {}
    Returns Promise<UploadResponse>

`Private` config

config: ConfigServiceInstance

`Private` `Optional` token

token?: string

`Static` _DEFAULT

_DEFAULT: boolean = true

`Static` _IN_CLIENT

_IN_CLIENT: boolean = false

Methods

`Private` addHeader

addHeader(headers, key, val): void
Parameters
- headers: Headers | [string, string][] | {
  [key: string]: string;
  }
- key: string
- val: string
Returns void
- Defined in src/services/ApiService.ts:46

connectToAmplify

connectToAmplify(): void
Returns void
- Defined in src/services/ApiService.ts:223

delete

delete<T>(url, options?): Promise<T>
Type Parameters
- T
Parameters
- url: string
- options: IAPIOptions = {}
Returns Promise<T>
- Defined in src/services/ApiService.ts:143

get

get<T>(url, options?): Promise<T>
Type Parameters
- T
Parameters
- url: string
- options: IAPIOptions = {}
Returns Promise<T>
- Defined in src/services/ApiService.ts:103

`Private` getBackendUrl

getBackendUrl(routeName, params?): string
Parameters
- routeName: string
- params: {
  [key: string]: string;
  } = {}
  - [key: string]: string
Returns string
- Defined in src/services/ApiService.ts:156

`Private` getHeaders

getHeaders(optHeaders?): HeadersInit
Parameters
- optHeaders: HeadersInit = {}
Returns HeadersInit
- Defined in src/services/ApiService.ts:58

getSingleton

getSingleton<T>(this): InterfaceSymbol<T>
Type Parameters
- T extends Key
Parameters
- this: IWithDI<T>
Returns InterfaceSymbol<T>
Inherited from RWSService.getSingleton
- Defined in src/services/_service.ts:24

isDefault

isDefault(): boolean
Returns boolean
Inherited from RWSService.isDefault
- Defined in src/services/_service.ts:53

isGetTargetReachable

isGetTargetReachable(url, options?): Promise<boolean>
Parameters
- url: string
- options: IAPIOptions = {}
Returns Promise<boolean>
- Defined in src/services/ApiService.ts:95

isInClient

isInClient(): boolean
Returns boolean
Inherited from RWSService.isInClient
- Defined in src/services/_service.ts:58

post

post<T, P>(url, payload?, options?): Promise<T>
Type Parameters
- T
- P extends object = object
Parameters
- url: string
- Optional payload: P
- options: IAPIOptions = {}
Returns Promise<T>
- Defined in src/services/ApiService.ts:115

pureGet

pureGet(url, options?): Promise<string>
Parameters
- url: string
- options: IAPIOptions = {}
Returns Promise<string>
- Defined in src/services/ApiService.ts:83

put

put<T, P>(url, payload?, options?): Promise<T>
Type Parameters
- T
- P extends object = object
Parameters
- url: string
- Optional payload: P
- options: IAPIOptions = {}
Returns Promise<T>
- Defined in src/services/ApiService.ts:129

register

register<T>(this): void
Type Parameters
- T extends Key
Parameters
- this: IWithDI<T>
Returns void
Inherited from RWSService.register
- Defined in src/services/_service.ts:19

setToken

setToken(token): void
Parameters
- token: string
Returns void
- Defined in src/services/ApiService.ts:78

uploadFile

uploadFile(url, file, onProgress, payload?): Promise<UploadResponse>
Parameters
- url: string
- file: File
- onProgress: ((progress) => void)
  - - (progress): void
    - Parameters
      progress: number
      Returns void
- payload: any = {}
Returns Promise<UploadResponse>
- Defined in src/services/ApiService.ts:199

`Static` getSingleton

getSingleton<T>(this): InterfaceSymbol<T>
Type Parameters
- T extends Key
Parameters
- this: IWithDI<T>
Returns InterfaceSymbol<T>
Inherited from RWSService.getSingleton
- Defined in src/services/_service.ts:34

`Static` register

register<T>(this): void
Type Parameters
- T extends Key
Parameters
- this: IWithDI<T>
Returns void
Inherited from RWSService.register
- Defined in src/services/_service.ts:29

Class ApiServiceInstance

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ConfigServiceInstance

Returns ApiServiceInstance

Properties

_RELOADABLE

back

Type declaration

delete: (<T>(routeName, options?) => Promise<T>)

Type Parameters

T

Parameters

routeName: string

Optional options: IAPIOptions

Returns Promise<T>

get: (<T>(routeName, options?) => Promise<T>)

Type Parameters

T

Parameters

routeName: string

Optional options: IAPIOptions

Returns Promise<T>

post: (<T, P>(routeName, payload?, options?) => Promise<T>)

Type Parameters

T

P extends object = object

Parameters

routeName: string

Optional payload: P

Optional options: IAPIOptions

Returns Promise<T>

put: (<T, P>(routeName, payload, options?) => Promise<T>)

Type Parameters

T

P extends object = object

Parameters

routeName: string

payload: P

Optional options: IAPIOptions

Returns Promise<T>

uploadFile: ((routeName, file, onProgress, options?, payload?) => Promise<UploadResponse>)

Parameters

routeName: string

file: File

onProgress: ((progress) => void)

Parameters

progress: number

Returns void

options: IAPIOptions = {}

payload: any = {}

Returns Promise<UploadResponse>

Private config

Private Optional token

Static _DEFAULT

Static _IN_CLIENT

Methods

Private addHeader

Parameters

headers: Headers | [string, string][] | { [key: string]: string; }

key: string

val: string

Returns void

connectToAmplify

Returns void

delete

Type Parameters

T

Parameters

url: string

options: IAPIOptions = {}

Returns Promise<T>

get

Type Parameters

`Optional` options: IAPIOptions

`Optional` options: IAPIOptions

`Optional` payload: P

`Optional` options: IAPIOptions

`Optional` options: IAPIOptions

`Private` config

`Private` `Optional` token

`Static` _DEFAULT

`Static` _IN_CLIENT

`Private` addHeader

headers: Headers | [string, string][] | {
[key: string]: string;
}

`Private` getBackendUrl

params: {
[key: string]: string;
} = {}

`Private` getHeaders

`Optional` payload: P

`Optional` payload: P