▪ Raw: RawResponse‹any, any›
RequestBuilder‹JsonResponse‹Raw››
↳ PostBuilder
+ new PostBuilder(httpClient: HttpClient, uri: string): PostBuilder
Overrides RequestBuilder.constructor
Defined in jsonApi.post.ts:10
Parameters:
Returns: PostBuilder
Optional attributes• attributes? : undefined | object
Defined in jsonApi.post.ts:9
Optional id• id? : undefined | string
Defined in jsonApi.post.ts:8
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.post.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.post.ts:7
• 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:
Returns: this
▸ ofType(type: string): this
Defined in jsonApi.post.ts:16
Parameters:
Returns: this
▸ pageLimit(limit: number): this
Inherited from RequestBuilder.pageLimit
Defined in jsonApi.builder.ts:102
Parameters:
Returns: this
▸ pageNumber(page: number | string | undefined): this
Inherited from RequestBuilder.pageNumber
Defined in jsonApi.builder.ts:112
Parameters:
Returns: this
▸ pageOffset(offset: number): this
Inherited from RequestBuilder.pageOffset
Defined in jsonApi.builder.ts:107
Parameters:
Returns: this
▸ parameter(key: string, value: string | number | boolean | undefined): this
Inherited from RequestBuilder.parameter
Defined in jsonApi.builder.ts:74
Parameters:
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:
Returns: Promise‹JsonResponse‹Raw››
▸ resolveIncluded(resolveIncluded?: undefined | false | true): this
Inherited from RequestBuilder.resolveIncluded
Defined in jsonApi.builder.ts:69
Parameters:
Returns: this
▸ send(options: HttpOptions): Promise‹JsonResponse‹Raw››
Overrides RequestBuilder.send
Defined in jsonApi.post.ts:43
Parameters:
Returns: Promise‹JsonResponse‹Raw››
▸ sort(key: string | undefined, order: SortOrder): this
Inherited from RequestBuilder.sort
Defined in jsonApi.builder.ts:95
Parameters:
Returns: this
▸ withAttributes(attributes: object): this
Defined in jsonApi.post.ts:26
Parameters:
Returns: this
▸ withId(id: string): this
Defined in jsonApi.post.ts:21
Parameters:
Returns: this
▸ withRelationship(rel?: undefined | object): this
Defined in jsonApi.post.ts:31
Parameters:
Returns: this
Name
Type
httpClient
HttpClient
uri
string
Name
Type
key
string | string[] | undefined
value
string | number | boolean | undefined
operator?
Name
Type
type
string
Name
Type
limit
number
Name
Type
page
number | string | undefined
Name
Type
offset
number
Name
Type
key
string
value
string | number | boolean | undefined
Name
Type
response
HttpResponse
Name
Type
resolveIncluded?
undefined | false | true
Name
Type
Default
options
HttpOptions
{}
Name
Type
key
string | undefined
order
Name
Type
attributes
object
Name
Type
id
string
Name
Type
rel?
undefined | object