▪ Raw: RawResponse‹any, any›
RequestBuilder‹JsonResponse‹Raw››
↳ UpdateBuilder
+ new UpdateBuilder(httpClient
: HttpClient, uri
: string, method
: "PATCH" | "PUT"): UpdateBuilder
Overrides RequestBuilder.constructor
Defined in jsonApi.update.ts:10
Parameters:
Name
Type
httpClient
HttpClient
uri
string
method
"PATCH" | "PUT"
Returns: UpdateBuilder
Optional
attributes• attributes? : undefined | object
Defined in jsonApi.update.ts:9
Optional
id• id? : undefined | string
Defined in jsonApi.update.ts:7
Protected
limit• limit: number = DEFAULT_RESOURCE_LIMIT
Inherited from RequestBuilder.limit
Defined in jsonApi.builder.ts:19
Protected
offset• offset: undefined | number
Inherited from RequestBuilder.offset
Defined in jsonApi.builder.ts:20
Protected
options• options: Options
Inherited from RequestBuilder.options
Defined in jsonApi.builder.ts:23
Protected
page• page: number = 1
Inherited from RequestBuilder.page
Defined in jsonApi.builder.ts:21
Protected
queryParams• queryParams: Record‹string, string›
Inherited from RequestBuilder.queryParams
Defined in jsonApi.builder.ts:17
Optional
relationships• relationships? : Record‹string, object›
Defined in jsonApi.update.ts:10
Protected
resolveIncludedRelationships• resolveIncludedRelationships: boolean = false
Inherited from RequestBuilder.resolveIncludedRelationships
Defined in jsonApi.builder.ts:16
Protected
sortParams• sortParams: string[] = []
Inherited from RequestBuilder.sortParams
Defined in jsonApi.builder.ts:18
Optional
type• type? : undefined | string
Defined in jsonApi.update.ts:8
• uri: string
Inherited from RequestBuilder.uri
Defined in jsonApi.builder.ts:15
• get parameters(): Record‹string, string›
Inherited from RequestBuilder.parameters
Defined in jsonApi.builder.ts:50
Returns: Record‹string, string›
▸ filter(key
: string | string[] | undefined, value
: string | number | boolean | undefined, operator?
: FilterOperator): this
Inherited from RequestBuilder.filter
Defined in jsonApi.builder.ts:84
Parameters:
Name
Type
key
string | string[] | undefined
value
string | number | boolean | undefined
operator?
Returns: this
▸ ofType(type
: string): this
Defined in jsonApi.update.ts:20
Parameters:
Name
Type
type
string
Returns: this
▸ pageLimit(limit
: number): this
Inherited from RequestBuilder.pageLimit
Defined in jsonApi.builder.ts:102
Parameters:
Name
Type
limit
number
Returns: this
▸ pageNumber(page
: number | string | undefined): this
Inherited from RequestBuilder.pageNumber
Defined in jsonApi.builder.ts:112
Parameters:
Name
Type
page
number | string | undefined
Returns: this
▸ pageOffset(offset
: number): this
Inherited from RequestBuilder.pageOffset
Defined in jsonApi.builder.ts:107
Parameters:
Name
Type
offset
number
Returns: this
▸ parameter(key
: string, value
: string | number | boolean | undefined): this
Inherited from RequestBuilder.parameter
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››
Inherited from RequestBuilder.parseResponse
Defined in jsonApi.builder.ts:117
Type parameters:
▪ Raw: RawResponse‹any, any›
Parameters:
Name
Type
response
HttpResponse
Returns: Promise‹JsonResponse‹Raw››
▸ resolveIncluded(resolveIncluded?
: undefined | false | true): this
Inherited from RequestBuilder.resolveIncluded
Defined in jsonApi.builder.ts:69
Parameters:
Name
Type
resolveIncluded?
undefined | false | true
Returns: this
▸ send(options
: HttpOptions): Promise‹JsonResponse‹Raw››
Overrides RequestBuilder.send
Defined in jsonApi.update.ts:43
Parameters:
Name
Type
Default
options
HttpOptions
{}
Returns: Promise‹JsonResponse‹Raw››
▸ sort(key
: string | undefined, order
: SortOrder): this
Inherited from RequestBuilder.sort
Defined in jsonApi.builder.ts:95
Parameters:
Name
Type
key
string | undefined
order
Returns: this
▸ withAttributes(attributes
: object): this
Defined in jsonApi.update.ts:30
Parameters:
Name
Type
attributes
object
Returns: this
▸ withId(id
: string): this
Defined in jsonApi.update.ts:25
Parameters:
Name
Type
id
string
Returns: this
▸ withRelationship(__namedParameters
: object): this
Defined in jsonApi.update.ts:35
Parameters:
▪ __namedParameters: object
Name
Type
name
string
type
string
uuid
string
Returns: this