Comment on page
UpdateBuilder
- ↳ UpdateBuilder
Parameters:
Name | Type |
httpClient | HttpClient |
uri | string |
method | "PATCH" | "PUT" |
• attributes? : undefined | object
• id? : undefined | string
• limit: number = DEFAULT_RESOURCE_LIMIT
• offset: undefined | number
• page: number = 1
• queryParams: Record‹string, string›
• relationships? : Record‹string, object›
• resolveIncludedRelationships: boolean = false
• sortParams: string[] = []
• type? : undefined | string
• uri: string
• get parameters(): Record‹string, string›
Returns: Record‹string, string›
▸ filter(
key: string | string[] | undefined, value: string | number | boolean | undefined, operator?: FilterOperator): thisParameters:
Name | Type |
key | string | string[] | undefined |
value | string | number | boolean | undefined |
operator? |
Returns: this
▸ ofType(
type: string): thisParameters:
Name | Type |
type | string |
Returns: this
▸ pageLimit(
limit: number): thisParameters:
Name | Type |
limit | number |
Returns: this
▸ pageNumber(
page: number | string | undefined): thisParameters:
Name | Type |
page | number | string | undefined |
Returns: this
▸ pageOffset(
offset: number): thisParameters:
Name | Type |
offset | number |
Returns: this
▸ parameter(
key: string, value: string | number | boolean | undefined): thisParameters:
Name | Type |
key | string |
value | string | number | boolean | undefined |
Returns: this
Type parameters:
Parameters:
Name | Type |
response | HttpResponse |
▸ resolveIncluded(
resolveIncluded?: undefined | false | true): thisParameters:
Name | Type |
resolveIncluded? | undefined | false | true |
Returns: this
Parameters:
Name | Type | Default |
options | HttpOptions | {} |
Parameters:
Name | Type |
key | string | undefined |
order |
Returns: this
▸ withAttributes(
attributes: object): thisParameters:
Name | Type |
attributes | object |
Returns: this
▸ withId(
id: string): thisParameters:
Name | Type |
id | string |
Returns: this
▸ withRelationship(
__namedParameters: object): thisParameters:
▪ __namedParameters: object
Name | Type |
name | string |
type | string |
uuid | string |
Returns: this
Last modified 3yr ago