Class: JSONAPISerializer

deprecated since v0.17, remove in v0.18

Implements

• Serializer<RecordDocument, ResourceDocument, JSONAPISerializationOptions, JSONAPISerializationOptions>

Constructors

constructor

• new JSONAPISerializer(settings)

Parameters

Name	Type
settings	JSONAPISerializerSettings

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:64

Accessors

keyMap

• get keyMap(): undefined | RecordKeyMap

Returns

undefined | RecordKeyMap

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:100

---

schema

• get schema(): RecordSchema

Returns

RecordSchema

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:96

---

serializerFor

• get serializerFor(): SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Returns

SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:104

Methods

deserialize

▸ deserialize(document, options?): RecordDocument

Parameters

Name	Type
document	ResourceDocument
options?	JSONAPISerializationOptions

Returns

RecordDocument

Implementation of

Serializer.deserialize

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:352

---

deserializeAtomicOperation

▸ deserializeAtomicOperation(operation): RecordOperation

Parameters

Name	Type
operation	ResourceAtomicOperation

Returns

RecordOperation

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:430

---

deserializeAtomicOperations

▸ deserializeAtomicOperations(operations): RecordOperation[]

Parameters

Name	Type
operations	ResourceAtomicOperation[]

Returns

RecordOperation[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:422

---

deserializeAtomicOperationsDocument

▸ deserializeAtomicOperationsDocument(document): RecordOperationsDocument

Parameters

Name	Type
document	ResourceAtomicOperationsDocument

Returns

RecordOperationsDocument

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:402

---

deserializeAttribute

▸ deserializeAttribute(record, attr, value, model): void

Parameters

Name	Type
record	InitializedRecord
attr	string
value	unknown
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:519

---

deserializeAttributes

▸ deserializeAttributes(record, resource, model): void

Parameters

Name	Type
record	InitializedRecord
resource	Resource
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:501

---

deserializeLinks

▸ deserializeLinks(record, resource, model): void

Parameters

Name	Type
record	InitializedRecord
resource	Resource
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:603

---

deserializeMeta

▸ deserializeMeta(record, resource, model): void

Parameters

Name	Type
record	InitializedRecord
resource	Resource
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:614

---

deserializeRelationship

▸ deserializeRelationship(record, relationship, value, model): void

Parameters

Name	Type
record	InitializedRecord
relationship	string
value	ResourceRelationship
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:567

---

deserializeRelationships

▸ deserializeRelationships(record, resource, model): void

Parameters

Name	Type
record	InitializedRecord
resource	Resource
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:549

---

deserializeResource

▸ deserializeResource(resource, primaryRecord?): InitializedRecord

Parameters

Name	Type
resource	Resource
primaryRecord?	InitializedRecord

Returns

InitializedRecord

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:486

---

deserializeResourceIdentity

▸ deserializeResourceIdentity(resource, primaryRecord?): InitializedRecord

Parameters

Name	Type
resource	Resource
primaryRecord?	InitializedRecord

Returns

InitializedRecord

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:436

---

recordAttribute

▸ recordAttribute(type, resourceAttribute): string

Parameters

Name	Type
type	string
resourceAttribute	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:182

---

recordId

▸ recordId(type, resourceId): string

Parameters

Name	Type
type	string
resourceId	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:150

---

recordIdentity

▸ recordIdentity(resourceIdentity): RecordIdentity

Parameters

Name	Type
resourceIdentity	ResourceIdentity

Returns

RecordIdentity

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:176

---

recordRelationship

▸ recordRelationship(type, resourceRelationship): string

Parameters

Name	Type
type	string
resourceRelationship	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:186

---

recordType

▸ recordType(resourceType): string

Parameters

Name	Type
resourceType	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:172

---

resourceAttribute

▸ resourceAttribute(type, attr): string

Parameters

Name	Type
type	undefined | string
attr	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:121

---

resourceId

▸ resourceId(type, id): undefined | string

Parameters

Name	Type
type	string
id	string

Returns

undefined | string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:136

---

resourceIdentity

▸ resourceIdentity(identity): Resource

Parameters

Name	Type
identity	RecordIdentity

Returns

Resource

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:125

---

resourceIds

▸ resourceIds(type, ids): (undefined | string)[]

Parameters

Name	Type
type	string
ids	string[]

Returns

(undefined | string)[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:132

---

resourceKey

▸ resourceKey(type): string

Parameters

Name	Type
type	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:109

---

resourceRelationship

▸ resourceRelationship(type, relationship): string

Parameters

Name	Type
type	undefined | string
relationship	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:117

---

resourceType

▸ resourceType(type): string

Parameters

Name	Type
type	string

Returns

string

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:113

---

serialize

▸ serialize(document): ResourceDocument

Parameters

Name	Type
document	RecordDocument

Returns

ResourceDocument

Implementation of

Serializer.serialize

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:190

---

serializeAtomicOperation

▸ serializeAtomicOperation(operation): ResourceAtomicOperation

Parameters

Name	Type
operation	RecordOperation

Returns

ResourceAtomicOperation

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:216

---

serializeAtomicOperations

▸ serializeAtomicOperations(operations): ResourceAtomicOperation[]

Parameters

Name	Type
operations	RecordOperation[]

Returns

ResourceAtomicOperation[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:208

---

serializeAtomicOperationsDocument

▸ serializeAtomicOperationsDocument(document): ResourceAtomicOperationsDocument

Parameters

Name	Type
document	RecordOperationsDocument

Returns

ResourceAtomicOperationsDocument

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:200

---

serializeAttribute

▸ serializeAttribute(resource, record, attr, model): void

Parameters

Name	Type
resource	Resource
record	InitializedRecord
attr	string
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:270

---

serializeAttributes

▸ serializeAttributes(resource, record, model): void

Parameters

Name	Type
resource	Resource
record	InitializedRecord
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:258

---

serializeId

▸ serializeId(resource, record, model): void

Parameters

Name	Type
resource	Resource
record	RecordIdentity
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:246

---

serializeIdentity

▸ serializeIdentity(record): Resource

Parameters

Name	Type
record	InitializedRecord

Returns

Resource

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:239

---

serializeRecord

▸ serializeRecord(record): Resource

Parameters

Name	Type
record	InitializedRecord

Returns

Resource

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:226

---

serializeRecords

▸ serializeRecords(records): Resource[]

Parameters

Name	Type
records	InitializedRecord[]

Returns

Resource[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:222

---

serializeRelationship

▸ serializeRelationship(resource, record, relationship, model): void

Parameters

Name	Type
resource	Resource
record	InitializedRecord
relationship	string
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:319

---

serializeRelationships

▸ serializeRelationships(resource, record, model): void

Parameters

Name	Type
resource	Resource
record	InitializedRecord
model	ModelDefinition

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-serializer.ts:307