Class: JSONAPIResourceSerializer
Hierarchy​
JSONAPIBaseSerializer
<InitializedRecord
,Resource
,unknown
,JSONAPIResourceIdentityDeserializationOptions
>↳
JSONAPIResourceSerializer
Constructors​
constructor​
• new JSONAPIResourceSerializer(settings
)
Parameters​
Name | Type |
---|---|
settings | Object |
settings.deserializationOptions? | JSONAPIResourceIdentityDeserializationOptions |
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(resource
, customOptions?
): InitializedRecord
Parameters​
Name | Type |
---|---|
resource | Resource |
customOptions? | JSONAPIResourceIdentityDeserializationOptions |
Returns​
InitializedRecord
Overrides​
JSONAPIBaseSerializer.deserialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-resource-serializer.ts:31
serialize​
â–¸ serialize(record
): Resource
Parameters​
Name | Type |
---|---|
record | InitializedRecord |
Returns​
Overrides​
JSONAPIBaseSerializer.serialize
Defined in​
packages/@orbit/jsonapi/src/serializers/jsonapi-resource-serializer.ts:19