Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
▪ Raw: RawListResponse‹any, any›
▪ I: IncludedGroups
JsonListResponse
+ new JsonListResponse(raw
: Raw, limit
: number, offset
: number | undefined, rawIncludedGroups
: I, response
: HttpResponse‹Raw›): JsonListResponse
Defined in jsonApi.getList.ts:8
Parameters:
Returns: JsonListResponse
• limit: number
Defined in jsonApi.getList.ts:12
• offset: number | undefined
Defined in jsonApi.getList.ts:13
• raw: Raw
Defined in jsonApi.getList.ts:11
• response: HttpResponse‹Raw›
Defined in jsonApi.getList.ts:15
• get elements(): MergedData‹Raw["data"]›
Defined in jsonApi.getList.ts:19
Returns: MergedData‹Raw["data"]›
• get included(): object
Defined in jsonApi.getList.ts:27
Returns: object
• get meta(): Raw["meta"]
Defined in jsonApi.getList.ts:23
Returns: Raw["meta"]
Name
Type
raw
Raw
limit
number
offset
number | undefined
rawIncludedGroups
I
response
HttpResponse‹Raw›
deprecated
It is not part of JSON API and is not supported in when array of keys is passed
• EQUALS: = "EQ"
Defined in jsonApi.interface.ts:146
• GREATER: = "GT"
Defined in jsonApi.interface.ts:149
• GREATER_OR_EQUAL: = "GE"
Defined in jsonApi.interface.ts:151
• LIKE: = "LIKE"
Defined in jsonApi.interface.ts:148
• LOWER: = "LT"
Defined in jsonApi.interface.ts:150
• LOWER_OR_EQUAL: = "LE"
Defined in jsonApi.interface.ts:152
• NOT_EQUALS: = "NEQ"
Defined in jsonApi.interface.ts:147
Ƭ AnyData: Data‹any, any›
Defined in jsonApi.interface.ts:46
Ƭ AttributesOf: D extends object ? D["attributes"] : EmptyRecord
Defined in jsonApi.interface.ts:49
Ƭ EmptyRecord: object
Defined in jsonApi.interface.ts:48
[ key: string]: never
Ƭ IncludedGroups: object
Defined in jsonApi.interface.ts:108
Ƭ IncludedGroupsSchema: Record‹string, IncludedGroup›
Defined in jsonApi.interface.ts:106
Ƭ IncludedRelationships: D[]
Defined in jsonApi.interface.ts:34
Ƭ MergedData:
Defined in jsonApi.interface.ts:60
This sophisticated type allows to correctly infer nicely formatted data from JSON API format. id
, type
, attributes
and relationships
suddenly become a single, combined object with easy access to it. Same is applied to arrays.
Ƭ MergedIncludedGroups: object
Defined in jsonApi.interface.ts:111
Ƭ OptionalRels: Relationships | undefined
Defined in jsonApi.interface.ts:32
Ƭ RawRelationship: object
Defined in jsonApi.interface.ts:14
data: T
links? : undefined | object
related? : undefined | string
Ƭ Relationship: RawRelationship‹RelationshipData›
Defined in jsonApi.interface.ts:23
Ƭ RelationshipArray: RawRelationship‹RelationshipData[]›
Defined in jsonApi.interface.ts:24
Ƭ RelationshipData: object
Defined in jsonApi.interface.ts:7
id: string
type: Type
Ƭ RelationshipType: RelationshipData‹Type› | RelationshipData‹Type›[]
Defined in jsonApi.interface.ts:12
Ƭ Relationships: Record‹string, RawRelationship‹RelationshipType› | undefined›
Defined in jsonApi.interface.ts:29
Ƭ RelationshipsOf: D extends object ? D["relationships"] : EmptyRecord
Defined in jsonApi.interface.ts:50
Ƭ ResolvedRelationship: RawRelationship‹D›
Defined in jsonApi.interface.ts:26
Ƭ ResolvedRelationshipArray: RawRelationship‹D[]›
Defined in jsonApi.interface.ts:27
Ƭ ResolvedRelationships: Record‹string, ResolvedRelationship | ResolvedRelationshipArray | undefined›
Defined in jsonApi.interface.ts:31
Ƭ UnresolvedRelationships: Record‹string, Relationship | RelationshipArray›
Defined in jsonApi.interface.ts:30
Const
DEFAULT_RESOURCE_LIMIT• DEFAULT_RESOURCE_LIMIT: 10 = 10
Defined in jsonApi.builder.ts:7
Const
findIncludedRelationship▸ findIncludedRelationship(relationship
: RelationshipData, included
: IncludedRelationships): AnyData | undefined
Defined in jsonApi.common.ts:41
Parameters:
Returns: AnyData | undefined
Const
includedGroup▸ includedGroup<D>(type
: string): IncludedGroup‹D›
Defined in jsonApi.common.ts:90
Type parameters:
▪ D: AnyData
Parameters:
Returns: IncludedGroup‹D›
Const
isData▸ isData<D>(data
: RelationshipData | D): data is D
Defined in jsonApi.common.ts:14
Type parameters:
▪ D: AnyData
Parameters:
Returns: data is D
Const
mergeElementData▸ mergeElementData<D>(data
: D): MergedData‹D›
Defined in jsonApi.common.ts:19
Type parameters:
▪ D: AnyData
Parameters:
Returns: MergedData‹D›
▸ resolveRelationships<D>(data
: D, included
: IncludedRelationships): D
Defined in jsonApi.common.ts:50
Type parameters:
Parameters:
Returns: D
▸ resolveRelationships(data
: RelationshipData[], included
: IncludedRelationships): object | Data‹any, any›[]
Defined in jsonApi.common.ts:54
Parameters:
Returns: object | Data‹any, any›[]
▸ resolveRelationships(data
: RelationshipData, included
: IncludedRelationships): AnyData | RelationshipData
Defined in jsonApi.common.ts:58
Parameters:
Returns: AnyData | RelationshipData
Const
HeadersDefined in jsonApi.interface.ts:137
• Accept: ContentType = ContentType.VND_JSON
Defined in jsonApi.interface.ts:139
• Content-Type: ContentType = ContentType.VND_JSON
Defined in jsonApi.interface.ts:138
▪ Raw: RawResponse‹any, any›
RequestBuilder‹JsonResponse‹Raw››
↳ GetBuilder
+ new GetBuilder(httpClient
: HttpClient, uri
: string): GetBuilder
Overrides RequestBuilder.constructor
Defined in jsonApi.get.ts:6
Parameters:
Returns: GetBuilder
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
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
• 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
▸ 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.get.ts:12
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
▪ Raw: RawResponse‹any, any›
RequestBuilder‹JsonResponse‹Raw››
↳ RemoveBuilder
+ new RemoveBuilder(httpClient
: HttpClient, uri
: string): RemoveBuilder
Overrides RequestBuilder.constructor
Defined in jsonApi.remove.ts:6
Parameters:
Returns: RemoveBuilder
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
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
• 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
▸ 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.remove.ts:12
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
▪ 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
▪ ResponseType
Protected
constructor+ new RequestBuilder(uri
: string, options
: Options): RequestBuilder
Defined in jsonApi.builder.ts:21
Parameters:
Returns: RequestBuilder
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: string
Defined in jsonApi.builder.ts:15
• get parameters(): Record‹string, string›
Defined in jsonApi.builder.ts:50
Returns: Record‹string, string›
▸ filter(key
: string | string[] | undefined, value
: string | number | boolean | undefined, operator?
: FilterOperator): this
Defined in jsonApi.builder.ts:84
Parameters:
Returns: this
▸ pageLimit(limit
: number): this
Defined in jsonApi.builder.ts:102
Parameters:
Returns: this
▸ pageNumber(page
: number | string | undefined): this
Defined in jsonApi.builder.ts:112
Parameters:
Returns: this
▸ pageOffset(offset
: number): this
Defined in jsonApi.builder.ts:107
Parameters:
Returns: this
▸ parameter(key
: string, value
: string | number | boolean | undefined): this
Defined in jsonApi.builder.ts:74
Parameters:
Returns: this
Protected
parseResponse▸ parseResponse<Raw>(response
: HttpResponse): Promise‹JsonResponse‹Raw››
Defined in jsonApi.builder.ts:117
Type parameters:
▪ Raw: RawResponse‹any, any›
Parameters:
Returns: Promise‹JsonResponse‹Raw››
▸ resolveIncluded(resolveIncluded?
: undefined | false | true): this
Defined in jsonApi.builder.ts:69
Parameters:
Returns: this
Abstract
send▸ send(options?
: HttpOptions): Promise‹ResponseType›
Defined in jsonApi.builder.ts:67
Parameters:
Returns: Promise‹ResponseType›
▸ sort(key
: string | undefined, order
: SortOrder): this
Defined in jsonApi.builder.ts:95
Parameters:
Returns: this
▪ Raw: RawResponse‹any, any›
JsonResponse
+ new JsonResponse(raw
: Raw, response
: HttpResponse‹Raw›): JsonResponse
Defined in jsonApi.response.ts:5
Parameters:
Returns: JsonResponse
• raw: Raw
Defined in jsonApi.response.ts:7
• response: HttpResponse‹Raw›
Defined in jsonApi.response.ts:7
• get element(): MergedData‹Raw["data"]›
Defined in jsonApi.response.ts:10
Returns: MergedData‹Raw["data"]›
• get meta(): Raw["meta"]
Defined in jsonApi.response.ts:14
Returns: Raw["meta"]
↳ UpdateBuilder
Parameters:
Optional
attributes• attributes? : undefined | object
Optional
id• id? : undefined | string
Protected
limit• limit: number = DEFAULT_RESOURCE_LIMIT
Protected
offset• offset: undefined | number
Protected
optionsProtected
page• page: number = 1
Protected
queryParams• queryParams: Record‹string, string›
Optional
relationships• relationships? : Record‹string, object›
Protected
resolveIncludedRelationships• resolveIncludedRelationships: boolean = false
Protected
sortParams• sortParams: string[] = []
Optional
type• type? : undefined | string
• uri: string
• get parameters(): Record‹string, string›
Returns: Record‹string, string›
Parameters:
Returns: this
▸ ofType(type
: string): this
Parameters:
Returns: this
▸ pageLimit(limit
: number): this
Parameters:
Returns: this
▸ pageNumber(page
: number | string | undefined): this
Parameters:
Returns: this
▸ pageOffset(offset
: number): this
Parameters:
Returns: this
▸ parameter(key
: string, value
: string | number | boolean | undefined): this
Parameters:
Returns: this
Protected
parseResponseType parameters:
Parameters:
▸ resolveIncluded(resolveIncluded?
: undefined | false | true): this
Parameters:
Returns: this
Parameters:
Parameters:
Returns: this
▸ withAttributes(attributes
: object): this
Parameters:
Returns: this
▸ withId(id
: string): this
Parameters:
Returns: this
▸ withRelationship(__namedParameters
: object): this
Parameters:
▪ __namedParameters: object
Returns: this
↳ GetListBuilder
Parameters:
Protected
limit• limit: number = DEFAULT_RESOURCE_LIMIT
Protected
offset• offset: undefined | number
Protected
optionsProtected
page• page: number = 1
Protected
queryParams• queryParams: Record‹string, string›
Protected
resolveIncludedRelationships• resolveIncludedRelationships: boolean = false
Protected
sortParams• sortParams: string[] = []
• uri: string
• get parameters(): Record‹string, string›
Returns: Record‹string, string›
Parameters:
Returns: this
Parameters:
Returns: this
Type parameters:
Parameters:
▸ pageLimit(limit
: number): this
Parameters:
Returns: this
▸ pageNumber(page
: number | string | undefined): this
Parameters:
Returns: this
▸ pageOffset(offset
: number): this
Parameters:
Returns: this
▸ parameter(key
: string, value
: string | number | boolean | undefined): this
Parameters:
Returns: this
Protected
parseResponseType parameters:
Parameters:
▸ resolveIncluded(resolveIncluded?
: undefined | false | true): this
Parameters:
Returns: this
Parameters:
Parameters:
Returns: this
JsonApiClient
Parameters:
• httpClient: HttpClient
Type parameters:
▪ M: object
Parameters:
Type parameters:
Parameters:
Type parameters:
▪ M: object
Parameters:
Type parameters:
▪ M: object
Parameters:
Type parameters:
▪ M: object
Parameters:
Type parameters:
▪ M: object
Parameters:
▪ Raw: ‹any, any›
‹‹Raw››
+ new UpdateBuilder(httpClient
: HttpClient, uri
: string, method
: "PATCH" | "PUT"):
Overrides .
Defined in
Returns:
Defined in
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
• options:
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ filter(key
: string | string[] | undefined, value
: string | number | boolean | undefined, operator?
: ): this
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ parseResponse<Raw>(response
: HttpResponse): Promise‹‹Raw››
Inherited from .
Defined in
▪ Raw: ‹any, any›
Returns: Promise‹‹Raw››
Inherited from .
Defined in
▸ send(options
: HttpOptions): Promise‹‹Raw››
Overrides .
Defined in
Returns: Promise‹‹Raw››
▸ sort(key
: string | undefined, order
: ): this
Inherited from .
Defined in
Defined in
Defined in
Defined in
▪ Raw: ‹any, any›
▪ I:
‹‹Raw, I››
+ new GetListBuilder(httpClient
: HttpClient, uri
: string):
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in
• options:
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ addToResponse(response
: ‹Raw, I› | undefined): this
Defined in
▸ filter(key
: string | string[] | undefined, value
: string | number | boolean | undefined, operator?
: ): this
Inherited from .
Defined in
▸ groupIncluded<Groups>(groups
: Groups): ‹Raw, ‹Groups››
Defined in
▪ Groups:
Returns: ‹Raw, ‹Groups››
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
▸ parseResponse<Raw>(response
: HttpResponse): Promise‹‹Raw››
Inherited from .
Defined in
▪ Raw: ‹any, any›
Returns: Promise‹‹Raw››
Overrides .
Defined in
▸ send(options?
: HttpOptions): Promise‹‹Raw, I››
Overrides .
Defined in
Returns: Promise‹‹Raw, I››
▸ sort(key
: string | undefined, order
: ): this
Inherited from .
Defined in
+ new JsonApiClient(httpClient
: HttpClient):
Defined in
Returns:
Defined in
▸ get<D, M>(uri
: string): ‹‹D, M››
Defined in
▪ D:
Returns: ‹‹D, M››
▸ getList<D, M>(uri
: string): ‹‹D, M›, object›
Defined in
▪ D:
▪ M:
Returns: ‹‹D, M›, object›
▸ patch<D, M>(uri
: string): ‹‹D, M››
Defined in
▪ D:
Returns: ‹‹D, M››
▸ post<D, M>(uri
: string): ‹‹D, M››
Defined in
▪ D:
Returns: ‹‹D, M››
▸ put<D, M>(uri
: string): ‹‹D, M››
Defined in
▪ D:
Returns: ‹‹D, M››
▸ remove<D, M>(uri
: string): ‹‹D, M››
Defined in
▪ D:
Returns: ‹‹D, M››
Defined in
Defined in
▪ D:
Defined in
Defined in
Defined in
Defined in
Defined in
▪ Attrs:
▪ Rels:
Defined in
Defined in
Defined in
Defined in
Defined in
Name
Type
relationship
included
Name
Type
type
string
Name
Type
data
RelationshipData | D
Name
Type
data
D
Name
Type
data
D
included
Name
Type
data
included
Name
Type
data
included
Name
Type
httpClient
HttpClient
uri
string
Name
Type
key
string | string[] | undefined
value
string | number | boolean | undefined
operator?
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
options?
HttpOptions
Name
Type
key
string | undefined
order
Name
Type
httpClient
HttpClient
uri
string
Name
Type
key
string | string[] | undefined
value
string | number | boolean | undefined
operator?
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
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
Name
Type
uri
string
options
Name
Type
key
string | string[] | undefined
value
string | number | boolean | undefined
operator?
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
options?
HttpOptions
Name
Type
key
string | undefined
order
Name
Type
raw
Raw
response
HttpResponse‹Raw›
Name | Type |
| HttpClient |
| string |
| "PATCH" | "PUT" |
Name | Type |
| string |
Name | Type |
| number |
Name | Type |
| number | string | undefined |
Name | Type |
| number |
Name | Type |
| string |
| string | number | boolean | undefined |
Name | Type |
| HttpResponse |
Name | Type |
| undefined | false | true |
Name | Type | Default |
| HttpOptions | {} |
Name | Type |
| object |
Name | Type |
| string |
Name | Type |
| string |
| string |
| string |
Name | Type |
| HttpClient |
| string |
Name | Type |
| Groups |
Name | Type |
| number |
Name | Type |
| number | string | undefined |
Name | Type |
| number |
Name | Type |
| string |
| string | number | boolean | undefined |
Name | Type |
| HttpResponse |
Name | Type |
| undefined | false | true |
Name | Type |
| HttpOptions |
Name | Type |
| HttpClient |
Name | Type |
| string |
Name | Type |
| string |
Name | Type |
| string |
Name | Type |
| string |
Name | Type |
| string |
Name | Type |
| string |
▪ D: AnyData
▪ M: ListMetaData
RawListResponse
• data: D[]
Defined in jsonApi.interface.ts:126
Optional
included• included? : IncludedRelationships
Defined in jsonApi.interface.ts:133
• links: object
Defined in jsonApi.interface.ts:127
first: string
last: string
next? : undefined | string
prev? : undefined | string
• meta: M
Defined in jsonApi.interface.ts:134
▪ D: AnyData
▪ M: object
RawResponse
• data: D
Defined in jsonApi.interface.ts:120
Optional
included• included? : IncludedRelationships
Defined in jsonApi.interface.ts:122
Optional
meta• meta? : M
Defined in jsonApi.interface.ts:121
Name | Type |
| string | string[] | undefined |
| string | number | boolean | undefined |
|
Name | Type |
| string | undefined |
|
Name | Type |
|
Name | Type |
| string | string[] | undefined |
| string | number | boolean | undefined |
|
Name | Type |
| string | undefined |
|
‹Raw, I› | undefined