RequestBuilder

Type parameters

ResponseType

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

+ new RequestBuilder(uri: string, options: Options): RequestBuilder

Defined in jsonApi.builder.ts:21

Parameters:

Name

Type

uri

string

options

Returns: RequestBuilder

Properties

Protected limit

limit: number = DEFAULT_RESOURCE_LIMIT

Defined in jsonApi.builder.ts:19

Protected offset

offset: undefined | number

Defined in jsonApi.builder.ts:20

Protected options

options: Options

Defined in jsonApi.builder.ts:23

Protected page

page: number = 1

Defined in jsonApi.builder.ts:21

Protected queryParams

queryParams: Record‹string, string›

Defined in jsonApi.builder.ts:17

Protected resolveIncludedRelationships

resolveIncludedRelationships: boolean = false

Defined in jsonApi.builder.ts:16

Protected sortParams

sortParams: string[] = []

Defined in jsonApi.builder.ts:18

uri

uri: string

Defined in jsonApi.builder.ts:15

Accessors

parameters

get parameters(): Record‹string, string›

Defined in jsonApi.builder.ts:50

Returns: Record‹string, string›

Methods

filter

filter(key: string | string[] | undefined, value: string | number | boolean | undefined, operator?: FilterOperator): this

Defined in jsonApi.builder.ts:84

Parameters:

Name

Type

key

string | string[] | undefined

value

string | number | boolean | undefined

operator?

Returns: this

pageLimit

pageLimit(limit: number): this

Defined in jsonApi.builder.ts:102

Parameters:

Name

Type

limit

number

Returns: this

pageNumber

pageNumber(page: number | string | undefined): this

Defined in jsonApi.builder.ts:112

Parameters:

Name

Type

page

number | string | undefined

Returns: this

pageOffset

pageOffset(offset: number): this

Defined in jsonApi.builder.ts:107

Parameters:

Name

Type

offset

number

Returns: this

parameter

parameter(key: string, value: string | number | boolean | undefined): this

Defined in jsonApi.builder.ts:74

Parameters:

Name

Type

key

string

value

string | number | boolean | undefined

Returns: this

Protected parseResponse

parseResponse<Raw>(response: HttpResponse): Promise‹JsonResponse‹Raw››

Defined in jsonApi.builder.ts:117

Type parameters:

Raw: RawResponse‹any, any›

Parameters:

Name

Type

response

HttpResponse

Returns: Promise‹JsonResponse‹Raw››

resolveIncluded

resolveIncluded(resolveIncluded?: undefined | false | true): this

Defined in jsonApi.builder.ts:69

Parameters:

Name

Type

resolveIncluded?

undefined | false | true

Returns: this

Abstract send

send(options?: HttpOptions): Promise‹ResponseType›

Defined in jsonApi.builder.ts:67

Parameters:

Name

Type

options?

HttpOptions

Returns: Promise‹ResponseType›

sort

sort(key: string | undefined, order: SortOrder): this

Defined in jsonApi.builder.ts:95

Parameters:

Name

Type

key

string | undefined

order

Returns: this

Last updated