ApiResource

@auvious/common / Exports / ApiResource

Class: ApiResource

Api resource implementation for auvious' services. This instance should be used for saving & reading on a specific resource over HTTP.

Hierarchy

• ApiResource

  ↳ ApiSearchResource

  ↳ ApiUserResource

Table of contents

Constructors

• constructor

Properties

• _client
• _postman
• _route
• _version
• log

Accessors

• parentClient
• route
• version

Methods

• _apiCall
• _appendReadHeaders
• _appendWriteHeaders
• create
• createGeneric
• delete
• deleteById
• deleteByIdGeneric
• deleteGeneric
• get
• getById
• getByIdGeneric
• getGeneric
• getPaged
• getPagedGeneric
• update
• updateById
• updateByIdGeneric
• updateGeneric

Constructors

constructor

• new ApiResource(client, route, version?)

Parameters

Name	Type	Default value
client	AuviousCommon	undefined
route	string	undefined
version	string	"1.0"

Properties

_client

• Protected _client: AuviousCommon

---

_postman

• Protected _postman: Postman

---

_route

• Protected _route: string

---

_version

• Protected _version: string

---

log

• Protected log: Logger

Accessors

parentClient

• get parentClient(): AuviousCommon

Gets the parent client of the api resource.

Returns

AuviousCommon

---

route

• get route(): string

Gets the resource default route. This is what is this._appended on the server url, before any route parameters.

.eg an api resource of route '/api/user' will get from http://server.url/api/user

Returns

string

---

version

• get version(): string

Gets the resource default version. This should be set in every request's X-REQUESTED-VERSION header.

Returns

string

Methods

_apiCall

▸ Protected _apiCall<ResourceT>(ResourceTctor, method, config, retries?, initialDelay?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type	Default value
ResourceTctor	(args: any) => ResourceT	undefined
method	string	undefined
config	any	undefined
retries	number	3
initialDelay	number	500

Returns

Promise<ResourceT>

---

_appendReadHeaders

▸ Protected _appendReadHeaders(config): void

Parameters

Name	Type
config	any

Returns

void

---

_appendWriteHeaders

▸ Protected _appendWriteHeaders(config): void

Parameters

Name	Type
config	any

Returns

void

---

create

▸ create(data, config?): Promise<any>

Parameters

Name	Type
data	any
config	any

Returns

Promise<any>

---

createGeneric

▸ createGeneric<ResourceT>(ResourceTctor, data, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
data	any
config	any

Returns

Promise<ResourceT>

---

delete

▸ delete(config?): Promise<any>

Parameters

Name	Type
config	any

Returns

Promise<any>

---

deleteById

▸ deleteById(id, config?): Promise<any>

Parameters

Name	Type
id	string
config	any

Returns

Promise<any>

---

deleteByIdGeneric

▸ deleteByIdGeneric<ResourceT>(ResourceTctor, id, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
id	string
config	any

Returns

Promise<ResourceT>

---

deleteGeneric

▸ deleteGeneric<ResourceT>(ResourceTctor, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
config	any

Returns

Promise<ResourceT>

---

get

▸ get(config?): Promise<any>

Just GET the god-damn thing.

Parameters

Name	Type	Description
config	any	axios compatible config

Returns

Promise<any>

http response body

---

getById

▸ getById(id, config?): Promise<any>

Parameters

Name	Type
id	string
config	any

Returns

Promise<any>

---

getByIdGeneric

▸ getByIdGeneric<ResourceT>(ResourceTctor, id, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
id	string
config	any

Returns

Promise<ResourceT>

---

getGeneric

▸ getGeneric<ResourceT>(ResourceTctor, config?): Promise<any>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
config	any

Returns

Promise<any>

---

getPaged

▸ getPaged(page, size, config?): Promise<any>

Parameters

Name	Type
page	number
size	number
config	any

Returns

Promise<any>

---

getPagedGeneric

▸ getPagedGeneric<ResourceT>(ResourceTctor, page, size, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
page	number
size	number
config	any

Returns

Promise<ResourceT>

---

update

▸ update(data, config?): Promise<any>

Parameters

Name	Type
data	any
config	any

Returns

Promise<any>

---

updateById

▸ updateById(id, data, config?): Promise<any>

Parameters

Name	Type
id	string
data	any
config	any

Returns

Promise<any>

---

updateByIdGeneric

▸ updateByIdGeneric<ResourceT>(ResourceTctor, id, data, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
id	string
data	any
config	any

Returns

Promise<ResourceT>

---

updateGeneric

▸ updateGeneric<ResourceT>(ResourceTctor, data, config?): Promise<ResourceT>

Type parameters

Name	Type
ResourceT	extends ApiResourceModel<ResourceT>

Parameters

Name	Type
ResourceTctor	(args: any) => ResourceT
data	any
config	any

Returns

Promise<ResourceT>