Class: JSONAPIDocumentSerializer
Hierarchy​
JSONAPIBaseSerializer<RecordDocument,ResourceDocument,unknown,JSONAPIDocumentDeserializationOptions>↳
JSONAPIDocumentSerializer
Constructors​
constructor​
• new JSONAPIDocumentSerializer(settings)
Parameters​
| Name | Type |
|---|---|
settings | Object |
settings.deserializationOptions? | JSONAPIDocumentDeserializationOptions |
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(resDocument, customOptions?): RecordDocument
Parameters​
| Name | Type |
|---|---|
resDocument | ResourceDocument |
customOptions? | JSONAPIDocumentDeserializationOptions |
Returns​
Overrides​
JSONAPIBaseSerializer.deserialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-document-serializer.ts:30
serialize​
â–¸ serialize(document): ResourceDocument
Parameters​
| Name | Type |
|---|---|
document | RecordDocument |
Returns​
Overrides​
JSONAPIBaseSerializer.serialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-document-serializer.ts:17