Type parameters

▪ D: AnyData

▪ M: object

Hierarchy

• RawResponse

Index

Properties

• data

• included

• meta

Properties

data

• 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

Type parameters

▪ Raw: RawListResponse‹any, any›

▪ I: IncludedGroups

Hierarchy

• JsonListResponse

Index

Constructors

• constructor

Properties

• limit

• offset

• raw

• response

Accessors

• elements

• included

• meta

Constructors

constructor

+ new JsonListResponse(raw: Raw, limit: number, offset: number | undefined, rawIncludedGroups: I, response: HttpResponse‹Raw›): JsonListResponse

Defined in jsonApi.getList.ts:8

Parameters:

Returns: JsonListResponse

Properties

limit

• limit: number

Defined in jsonApi.getList.ts:12

offset

• offset: number | undefined

Defined in jsonApi.getList.ts:13

raw

• raw: Raw

Defined in jsonApi.getList.ts:11

response

• response: HttpResponse‹Raw›

Defined in jsonApi.getList.ts:15

Accessors

elements

• get elements(): MergedData‹Raw["data"]›

Defined in jsonApi.getList.ts:19

Returns: MergedData‹Raw["data"]›

included

• get included(): object

Defined in jsonApi.getList.ts:27

Returns: object

meta

• get meta(): Raw["meta"]

Defined in jsonApi.getList.ts:23

Returns: Raw["meta"]

Type parameters

▪ Raw: ‹any, any›

▪ I:

Hierarchy

• ‹‹Raw, I››

  ↳ GetListBuilder

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters:

Properties

Protected limit

• limit: number = DEFAULT_RESOURCE_LIMIT

Protected offset

• offset: undefined | number

Protected options

Protected page

• page: number = 1

Protected queryParams

• queryParams: Record‹string, string›

Protected resolveIncludedRelationships

• resolveIncludedRelationships: boolean = false

Protected sortParams

• sortParams: string[] = []

uri

• uri: string

Accessors

parameters

• get parameters(): Record‹string, string›

Returns: Record‹string, string›

Methods

addToResponse

Parameters:

Returns: this

filter

Parameters:

Returns: this

groupIncluded

Type parameters:

Parameters:

pageLimit

▸ pageLimit(limit: number): this

Parameters:

Returns: this

pageNumber

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

Parameters:

Returns: this

pageOffset

▸ pageOffset(offset: number): this

Parameters:

Returns: this

parameter

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

Parameters:

Returns: this

Protected parseResponse

Type parameters:

Parameters:

resolveIncluded

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

Parameters:

Returns: this

send

Parameters:

sort

Parameters:

Returns: this

Type parameters

▪ Raw: ‹any, any›

Hierarchy

• JsonResponse

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters:

Properties

raw

• raw: Raw

response

• response: HttpResponse‹Raw›

Accessors

element

meta

• get meta(): Raw["meta"]

Returns: Raw["meta"]

Type parameters

▪ Raw: RawResponse‹any, any›

Hierarchy

• RequestBuilder‹JsonResponse‹Raw››

  ↳ PostBuilder

Index

Constructors

• constructor

Properties

• attributes

• id

• limit

• offset

• options

• page

• queryParams

• relationships

• resolveIncludedRelationships

• sortParams

• type

• uri

Accessors

• parameters

Methods

• filter

• ofType

• pageLimit

• pageNumber

• pageOffset

• parameter

• parseResponse

• resolveIncluded

• send

• sort

• withAttributes

• withId

• withRelationship

Constructors

constructor

+ new PostBuilder(httpClient: HttpClient, uri: string): PostBuilder

Overrides RequestBuilder.constructor

Defined in jsonApi.post.ts:10

Parameters:

Returns: PostBuilder

Properties

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

• uri: string

Inherited from RequestBuilder.uri

Defined in jsonApi.builder.ts:15

Accessors

parameters

• get parameters(): Record‹string, string›

Inherited from RequestBuilder.parameters

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

Inherited from RequestBuilder.filter

Defined in jsonApi.builder.ts:84

Parameters:

Returns: this

ofType

▸ ofType(type: string): this

Defined in jsonApi.post.ts:16

Parameters:

Returns: this

pageLimit

▸ pageLimit(limit: number): this

Inherited from RequestBuilder.pageLimit

Defined in jsonApi.builder.ts:102

Parameters:

Returns: this

pageNumber

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

Inherited from RequestBuilder.pageNumber

Defined in jsonApi.builder.ts:112

Parameters:

Returns: this

pageOffset

▸ pageOffset(offset: number): this

Inherited from RequestBuilder.pageOffset

Defined in jsonApi.builder.ts:107

Parameters:

Returns: this

parameter

▸ 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(resolveIncluded?: undefined | false | true): this

Inherited from RequestBuilder.resolveIncluded

Defined in jsonApi.builder.ts:69

Parameters:

Returns: this

send

▸ send(options: HttpOptions): Promise‹JsonResponse‹Raw››

Overrides RequestBuilder.send

Defined in jsonApi.post.ts:43

Parameters:

Returns: Promise‹JsonResponse‹Raw››

sort

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

Inherited from RequestBuilder.sort

Defined in jsonApi.builder.ts:95

Parameters:

Returns: this

withAttributes

▸ withAttributes(attributes: object): this

Defined in jsonApi.post.ts:26

Parameters:

Returns: this

withId

▸ withId(id: string): this

Defined in jsonApi.post.ts:21

Parameters:

Returns: this

withRelationship

▸ withRelationship(rel?: undefined | object): this

Defined in jsonApi.post.ts:31

Parameters:

Returns: this

Hierarchy

• JsonApiClient

Index

Constructors

• constructor

Properties

• httpClient

Methods

• get

• getList

• patch

• post

• put

• remove

Constructors

constructor

+ new JsonApiClient(httpClient: HttpClient): JsonApiClient

Defined in jsonApi.client.ts:9

Parameters:

Returns: JsonApiClient

Properties

httpClient

• httpClient: HttpClient

Defined in jsonApi.client.ts:10

Methods

get

▸ get<D, M>(uri: string): GetBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:13

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Returns: GetBuilder‹RawResponse‹D, M››

getList

▸ getList<D, M>(uri: string): GetListBuilder‹RawListResponse‹D, M›, object›

Defined in jsonApi.client.ts:17

Type parameters:

▪ D: AnyData

▪ M: ListMetaData

Parameters:

Returns: GetListBuilder‹RawListResponse‹D, M›, object›

patch

▸ patch<D, M>(uri: string): UpdateBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:33

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Returns: UpdateBuilder‹RawResponse‹D, M››

post

▸ post<D, M>(uri: string): PostBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:21

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Returns: PostBuilder‹RawResponse‹D, M››

put

▸ put<D, M>(uri: string): UpdateBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:29

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Returns: UpdateBuilder‹RawResponse‹D, M››

remove

▸ remove<D, M>(uri: string): RemoveBuilder‹RawResponse‹D, M››

Defined in jsonApi.client.ts:25

Type parameters:

▪ D: AnyData

▪ M: object

Parameters:

Returns: RemoveBuilder‹RawResponse‹D, M››

Type parameters

▪ Raw: ‹any, any›

Hierarchy

• ‹‹Raw››

  ↳ GetBuilder

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters:

Properties

Protected limit

• limit: number = DEFAULT_RESOURCE_LIMIT

Protected offset

• offset: undefined | number

Protected options

Protected page

• page: number = 1

Protected queryParams

• queryParams: Record‹string, string›

Protected resolveIncludedRelationships

• resolveIncludedRelationships: boolean = false

Protected sortParams

• sortParams: string[] = []

uri

• uri: string

Accessors

parameters

• get parameters(): Record‹string, string›

Returns: Record‹string, string›

Methods

filter

Parameters:

Returns: this

pageLimit

▸ pageLimit(limit: number): this

Parameters:

Returns: this

pageNumber

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

Parameters:

Returns: this

pageOffset

▸ pageOffset(offset: number): this

Parameters:

Returns: this

parameter

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

Parameters:

Returns: this

Protected parseResponse

Type parameters:

Parameters:

resolveIncluded

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

Parameters:

Returns: this

send

Parameters:

sort

Parameters:

Returns: this

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnyData

AttributesOf

Ƭ AttributesOf: D extends object ? D["attributes"] : EmptyRecord

EmptyRecord

Ƭ EmptyRecord: object

Type declaration:

• [ key: string]: never

IncludedGroups

Ƭ IncludedGroups: object

Type declaration:

IncludedGroupsSchema

IncludedRelationships

Ƭ IncludedRelationships: D[]

MergedData

Ƭ MergedData:

MergeData type

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

Ƭ MergedIncludedGroups: object

Type declaration:

OptionalRels

RawRelationship

Ƭ RawRelationship: object

Type declaration:

• data: T

• links? : undefined | object

• related? : undefined | string

Relationship

RelationshipArray

RelationshipData

Ƭ RelationshipData: object

Type declaration:

• id: string

• type: Type

RelationshipType

Relationships

RelationshipsOf

Ƭ RelationshipsOf: D extends object ? D["relationships"] : EmptyRecord

ResolvedRelationship

ResolvedRelationshipArray

ResolvedRelationships

UnresolvedRelationships

Variables

Const DEFAULT_RESOURCE_LIMIT

• DEFAULT_RESOURCE_LIMIT: 10 = 10

Functions

Const findIncludedRelationship

Parameters:

Const includedGroup

Type parameters:

Parameters:

Const isData

Type parameters:

Parameters:

Returns: data is D

Const mergeElementData

Type parameters:

Parameters:

resolveRelationships

Type parameters:

Parameters:

Returns: D

Parameters:

Parameters:

Object literals

Const Headers

▪ Headers: object

Accept

• Accept: ContentType = ContentType.VND_JSON

Content-Type

• Content-Type: ContentType = ContentType.VND_JSON

Type parameters

▪ ResponseType

Hierarchy

• RequestBuilder

  ↳

  ↳

  ↳

  ↳

  ↳

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters:

Properties

Protected limit

• limit: number = DEFAULT_RESOURCE_LIMIT

Protected offset

• offset: undefined | number

Protected options

Protected page

• page: number = 1

Protected queryParams

• queryParams: Record‹string, string›

Protected resolveIncludedRelationships

• resolveIncludedRelationships: boolean = false

Protected sortParams

• sortParams: string[] = []

uri

• uri: string

Accessors

parameters

• get parameters(): Record‹string, string›

Returns: Record‹string, string›

Methods

filter

Parameters:

Returns: this

pageLimit

▸ pageLimit(limit: number): this

Parameters:

Returns: this

pageNumber

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

Parameters:

Returns: this

pageOffset

▸ pageOffset(offset: number): this

Parameters:

Returns: this

parameter

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

Parameters:

Returns: this

Protected parseResponse

Type parameters:

Parameters:

resolveIncluded

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

Parameters:

Returns: this

Abstract send

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

Parameters:

Returns: Promise‹ResponseType›

sort

Parameters:

Returns: this

Type parameters

▪ Raw: ‹any, any›

Hierarchy

• ‹‹Raw››

  ↳ RemoveBuilder

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters:

Properties

Protected limit

• limit: number = DEFAULT_RESOURCE_LIMIT

Protected offset

• offset: undefined | number

Protected options

Protected page

• page: number = 1

Protected queryParams

• queryParams: Record‹string, string›

Protected resolveIncludedRelationships

• resolveIncludedRelationships: boolean = false

Protected sortParams

• sortParams: string[] = []

uri

• uri: string

Accessors

parameters

• get parameters(): Record‹string, string›

Returns: Record‹string, string›

Methods

filter

Parameters:

Returns: this

pageLimit

▸ pageLimit(limit: number): this

Parameters:

Returns: this

pageNumber

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

Parameters:

Returns: this

pageOffset

▸ pageOffset(offset: number): this

Parameters:

Returns: this

parameter

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

Parameters:

Returns: this

Protected parseResponse

Type parameters:

Parameters:

resolveIncluded

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

Parameters:

Returns: this

send

Parameters:

sort

Parameters:

Returns: this

Type parameters

▪ Attrs:

▪ Rels:

Hierarchy

• Data

Index

Properties

Properties

attributes

• attributes: Attrs

id

• id: string

links

• links: object

Type declaration:

• self: string

relationships

• relationships: Rels

type

• type: string

deprecated It is not part of JSON API and is not supported in when array of keys is passed

Index

Enumeration members

Enumeration members

EQUALS

• EQUALS: = "EQ"

Defined in

GREATER

• GREATER: = "GT"

GREATER_OR_EQUAL

• GREATER_OR_EQUAL: = "GE"

LIKE

• LIKE: = "LIKE"

LOWER

• LOWER: = "LT"

LOWER_OR_EQUAL

• LOWER_OR_EQUAL: = "LE"

NOT_EQUALS

• NOT_EQUALS: = "NEQ"