Class: JSONAPIAtomicResultsDocumentSerializer
Hierarchy​
JSONAPIBaseSerializer<RecordResultsDocument,ResourceAtomicResultsDocument,unknown,unknown>↳
JSONAPIAtomicResultsDocumentSerializer
Constructors​
constructor​
• new JSONAPIAtomicResultsDocumentSerializer(settings)
Parameters​
| Name | Type |
|---|---|
settings | Object |
settings.deserializationOptions? | unknown |
settings.keyMap? | RecordKeyMap |
settings.schema | RecordSchema |
settings.serializationOptions? | unknown |
settings.serializerFor | SerializerForFn<Serializer<unknown, unknown, unknown, unknown>> |
Inherited from​
JSONAPIBaseSerializer.constructor
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:31
Properties​
serializerFor​
• serializerFor: SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>
Inherited from​
JSONAPIBaseSerializer.serializerFor
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:27
Accessors​
keyMap​
• get keyMap(): undefined | RecordKeyMap
Returns​
undefined | RecordKeyMap
Inherited from​
JSONAPIBaseSerializer.keyMap
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:58
schema​
• get schema(): RecordSchema
Returns​
RecordSchema
Inherited from​
JSONAPIBaseSerializer.schema
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:54
Methods​
deserialize​
â–¸ deserialize(document): RecordResultsDocument
Parameters​
| Name | Type |
|---|---|
document | ResourceAtomicResultsDocument |
Returns​
Overrides​
JSONAPIBaseSerializer.deserialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-atomic-results-document-serializer.ts:42
deserializeAtomicResults​
â–¸ deserializeAtomicResults(results): InitializedRecord[]
Parameters​
| Name | Type |
|---|---|
results | Resource[] |
Returns​
InitializedRecord[]
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-atomic-results-document-serializer.ts:53
serialize​
â–¸ serialize(document): ResourceAtomicResultsDocument
Parameters​
| Name | Type |
|---|---|
document | RecordResultsDocument |
Returns​
Overrides​
JSONAPIBaseSerializer.serialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-atomic-results-document-serializer.ts:15
serializeResults​
â–¸ serializeResults(results): Resource[]
Parameters​
| Name | Type |
|---|---|
results | InitializedRecord[] |
Returns​
Resource[]
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-atomic-results-document-serializer.ts:26