Skip to main content
Version: 0.17

@orbit/jsonapi

Enumerations​

Classes​

Interfaces​

References​

default​

Renames and re-exports JSONAPISource

Type aliases​

PrimaryResourceData​

Ƭ PrimaryResourceData: Resource | Resource[] | ResourceIdentity | ResourceIdentity[] | null

Defined in​

packages/@orbit/jsonapi/src/resource-document.ts:34


QueryRequestProcessorResponse​

Ƭ QueryRequestProcessorResponse: FullResponse<RecordQueryExpressionResult, JSONAPIResponse, RecordOperation>

Defined in​

packages/@orbit/jsonapi/src/lib/query-requests.ts:59


RecordDocumentOrDocuments​

Ƭ RecordDocumentOrDocuments: RecordDocument | RecordDocument[]

Defined in​

packages/@orbit/jsonapi/src/record-document.ts:11


RecordQueryRequest​

Ƭ RecordQueryRequest: FindRecordRequest | FindRecordsRequest | FindRelatedRecordRequest | FindRelatedRecordsRequest

Defined in​

packages/@orbit/jsonapi/src/lib/query-requests.ts:53


RecordTransformRequest​

Ƭ RecordTransformRequest: AddRecordRequest | RemoveRecordRequest | UpdateRecordRequest | AddToRelatedRecordsRequest | RemoveFromRelatedRecordsRequest | ReplaceRelatedRecordRequest | ReplaceRelatedRecordsRequest

Defined in​

packages/@orbit/jsonapi/src/lib/transform-requests.ts:78


ResourceRelationship​

Ƭ ResourceRelationship: ResourceHasOneRelationship | ResourceHasManyRelationship

Defined in​

packages/@orbit/jsonapi/src/resource-document.ts:21


TransformRequestProcessorResponse​

Ƭ TransformRequestProcessorResponse: FullResponse<RecordOperationResult, JSONAPIResponse, RecordOperation>

Defined in​

packages/@orbit/jsonapi/src/lib/transform-requests.ts:87

Variables​

QueryRequestProcessors​

• QueryRequestProcessors: Dict<QueryRequestProcessor>

Defined in​

packages/@orbit/jsonapi/src/lib/query-requests.ts:144


TransformRequestProcessors​

• TransformRequestProcessors: Dict<TransformRequestProcessor>

Defined in​

packages/@orbit/jsonapi/src/lib/transform-requests.ts:100

Functions​

appendQueryParams​

â–¸ appendQueryParams(url, obj): string

Parameters​

NameType
urlstring
objDict<string>

Returns​

string

Defined in​

packages/@orbit/jsonapi/src/lib/query-params.ts:66


buildJSONAPISerializerFor​

â–¸ buildJSONAPISerializerFor(settings): SerializerForFn

Parameters​

NameType
settingsObject
settings.keyMap?RecordKeyMap
settings.schemaRecordSchema
settings.serializerClassFor?SerializerClassForFn<Serializer<unknown, unknown, unknown, unknown>>
settings.serializerFor?SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>
settings.serializerSettingsFor?SerializerSettingsForFn

Returns​

SerializerForFn

Defined in​

packages/@orbit/jsonapi/src/serializers/jsonapi-serializer-builder.ts:25


encodeQueryParams​

â–¸ encodeQueryParams(obj): string

Parameters​

NameType
objDict<any>

Returns​

string

Defined in​

packages/@orbit/jsonapi/src/lib/query-params.ts:40


getQueryRequests​

â–¸ getQueryRequests(requestProcessor, query): RecordQueryRequest[]

Parameters​

NameType
requestProcessorJSONAPIRequestProcessor
queryRecordQuery

Returns​

RecordQueryRequest[]

Defined in​

packages/@orbit/jsonapi/src/lib/query-requests.ts:72


getTransformRequests​

â–¸ getTransformRequests(requestProcessor, transform): RecordTransformRequest[]

Parameters​

NameType
requestProcessorJSONAPIRequestProcessor
transformRecordTransform

Returns​

RecordTransformRequest[]

Defined in​

packages/@orbit/jsonapi/src/lib/transform-requests.ts:316