Class BaseService

A base class for web api services using the axios http client.

Hierarchy

BaseService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseService(baseURL: string, controllerName: string, tokenFactory?: undefined | (() => Promise<string | null>)): BaseService

- Defined in packages/traversal-core/src/Services/BaseService.ts:6
Parameters
- baseURL: string
  
  The service's [[baseURL]] including the trailing /
- controllerName: string
  
  The service's controllerName
- Optional tokenFactory: undefined | (() => Promise<string | null>)
  
  Optional factory to set axios instance's token before http calls.'
Returns BaseService

Properties

Protected axios

axios: AxiosInstance

The axios instance used by this service.

Private controllerName

controllerName: string

The name of the controller, used in constructing the axios instance's baseURL.

Methods

setBaseUrl

setBaseUrl(baseURL: string): void

- Defined in packages/traversal-core/src/Services/BaseService.ts:49
Set the service's [[baseURL]] e.g. /engine/ or https://prod-platform-traversal-engine.doctorlink.engineering/api/v2/tenantId/

Parameters
- baseURL: string
  
  e.g. /engine/
Returns void

setToken

setToken(token: string | null): void

- Defined in packages/traversal-core/src/Services/BaseService.ts:57
Set the token to use in the service's axios instance

Parameters
- token: string | null
  
  Bearer token or null.
Returns void