Class BaseResource`Abstract`

All classes in the resource folder should implement this interface so that they can be instantiated in the main barrel.

Hierarchy (view full)

BaseResource

Index

Constructors

Methods

execute throwIfLimitOrPageAreInvalid throwIfNullOrUndefined

Constructors

constructor

new BaseResource(): BaseResource
Returns BaseResource

Methods

`Protected`execute

execute<T>(call): Promise<T>
A helper function to ensure that API calls are successful and return a valid status code.
Type Parameters
- T
Parameters
- call: (() => Promise<AxiosResponse<T, any>>)
  The API call to guard for exceptions and bad return codes.
  - - (): Promise<AxiosResponse<T, any>>
    - Returns Promise<AxiosResponse<T, any>>
Returns Promise<T>
A promise of the type returned by Axios in the data field.
- Defined in src/resources/BaseResource.ts:45

`Protected`throwIfLimitOrPageAreInvalid

throwIfLimitOrPageAreInvalid(limit, page): void
A helper function to validate limit and paging parameters.
Parameters
- limit: number
  Must be between 1 and 100 inclusive.
- page: number
  Must be greater than 0
Returns void
- Defined in src/resources/BaseResource.ts:29

`Protected`throwIfNullOrUndefined

throwIfNullOrUndefined<T>(name, value): T
A helper function that will either return the variable's value or throw an exception if the value is null or undefined. Unit testing is simplified by avoiding ??
Type Parameters
- T
Parameters
- name: string
  The name of the variable being checked
- value: undefined | null | T
  The value of the variable being checked
Returns T
The value of the variable if it is available, otherwise an exception is thrown.
- Defined in src/resources/BaseResource.ts:17