Class: JSONAPIBaseSerializer<From, To, SerializationOptions, DeserializationOptions>

Type parameters

Name
From
To
SerializationOptions
DeserializationOptions

Hierarchy

• BaseSerializer<From, To, SerializationOptions, DeserializationOptions>

  ↳ JSONAPIBaseSerializer

  ↳↳ JSONAPIDocumentSerializer

  ↳↳ JSONAPIAtomicOperationSerializer

  ↳↳ JSONAPIAtomicOperationsDocumentSerializer

  ↳↳ JSONAPIAtomicResultsDocumentSerializer

  ↳↳ JSONAPIResourceIdentitySerializer

  ↳↳ JSONAPIResourceSerializer

Constructors

constructor

• new JSONAPIBaseSerializer<From, To, SerializationOptions, DeserializationOptions>(settings)

Type parameters

Name
From
To
SerializationOptions
DeserializationOptions

Parameters

Name	Type
settings	Object
settings.deserializationOptions?	DeserializationOptions
settings.keyMap?	RecordKeyMap
settings.schema	RecordSchema
settings.serializationOptions?	SerializationOptions
settings.serializerFor	SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Overrides

BaseSerializer< From, To, SerializationOptions, DeserializationOptions \>.constructor

Defined in

packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:31

Properties

serializerFor

• serializerFor: SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Overrides

BaseSerializer.serializerFor

Defined in

packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:27

Accessors

keyMap

• get keyMap(): undefined | RecordKeyMap

Returns

undefined | RecordKeyMap

Defined in

packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:58

---

schema

• get schema(): RecordSchema

Returns

RecordSchema

Defined in

packages/@orbit/jsonapi/src/serializers/jsonapi-base-serializer.ts:54

Methods

deserialize

▸ Abstract deserialize(arg, options?): From

Parameters

Name	Type
arg	To
options?	DeserializationOptions

Returns

From

Inherited from

BaseSerializer.deserialize

Defined in

packages/@orbit/serializers/dist/modules/base-serializer.d.ts:15

---

serialize

▸ Abstract serialize(arg, options?): To

Parameters

Name	Type
arg	From
options?	SerializationOptions

Returns

To

Inherited from

BaseSerializer.serialize

Defined in

packages/@orbit/serializers/dist/modules/base-serializer.d.ts:14