@orbit/jsonapi
Enumerations​
Classes​
- ClientError
- InvalidServerResponse
- JSONAPIAtomicOperationSerializer
- JSONAPIAtomicOperationsDocumentSerializer
- JSONAPIAtomicResultsDocumentSerializer
- JSONAPIBaseSerializer
- JSONAPIDocumentSerializer
- JSONAPIRequestProcessor
- JSONAPIResourceFieldSerializer
- JSONAPIResourceIdentitySerializer
- JSONAPIResourceSerializer
- JSONAPISerializer
- JSONAPISource
- JSONAPIURLBuilder
- NetworkError
- ServerError
Interfaces​
- AddRecordRequest
- AddResourceAtomicOperation
- AddToRelatedRecordsRequest
- AddToRelatedResourcesAtomicOperation
- BaseTransformRecordRequest
- ExpressionToRequestConverter
- FetchSettings
- FindRecordRequest
- FindRecordsRequest
- FindRelatedRecordRequest
- FindRelatedRecordsRequest
- JSONAPIDocumentDeserializationOptions
- JSONAPIQueryOptions
- JSONAPIRequestOptions
- JSONAPIRequestProcessorSettings
- JSONAPIResourceFieldSerializationOptions
- JSONAPIResourceIdentityDeserializationOptions
- JSONAPIResourceIdentitySerializerSettings
- JSONAPIResponse
- JSONAPISerializationOptions
- JSONAPISerializerSettings
- JSONAPISourceSettings
- JSONAPITransformOptions
- JSONAPIURLBuilderSettings
- OperationToRequestConverter
- Param
- QueryRequest
- QueryRequestProcessor
- RecordDocument
- RecordOperationsDocument
- RecordResultsDocument
- RemoveFromRelatedRecordsRequest
- RemoveFromRelatedResourcesAtomicOperation
- RemoveRecordRequest
- RemoveResourceAtomicOperation
- ReplaceRelatedRecordRequest
- ReplaceRelatedRecordsRequest
- ReplaceRelatedResourceAtomicOperation
- ReplaceRelatedResourcesAtomicOperation
- Resource
- ResourceAtomicOperation
- ResourceAtomicOperationsDocument
- ResourceAtomicResultsDocument
- ResourceDocument
- ResourceHasManyRelationship
- ResourceHasOneRelationship
- ResourceIdentity
- TransformRecordRelationshipRequest
- TransformRequestProcessor
- UpdateRecordRequest
- UpdateResourceAtomicOperation
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​
| Name | Type |
|---|---|
url | string |
obj | Dict<string> |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/lib/query-params.ts:66
buildJSONAPISerializerFor​
â–¸ buildJSONAPISerializerFor(settings): SerializerForFn
Parameters​
| Name | Type |
|---|---|
settings | Object |
settings.keyMap? | RecordKeyMap |
settings.schema | RecordSchema |
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​
| Name | Type |
|---|---|
obj | Dict<any> |
Returns​
string
Defined in​
packages/@orbit/jsonapi/src/lib/query-params.ts:40
getQueryRequests​
â–¸ getQueryRequests(requestProcessor, query): RecordQueryRequest[]
Parameters​
| Name | Type |
|---|---|
requestProcessor | JSONAPIRequestProcessor |
query | RecordQuery |
Returns​
Defined in​
packages/@orbit/jsonapi/src/lib/query-requests.ts:72
getTransformRequests​
â–¸ getTransformRequests(requestProcessor, transform): RecordTransformRequest[]
Parameters​
| Name | Type |
|---|---|
requestProcessor | JSONAPIRequestProcessor |
transform | RecordTransform |