Class: RestDeserializer
rest.RestDeserializer
Hierarchy
ObjectDeserializer<Response,RestNewResource>↳
RestDeserializer
Constructors
constructor
• new RestDeserializer(config?)
Parameters
| Name | Type |
|---|---|
config? | Object |
config.dataExtractor? | null | DataExtractor |
config.dataReader? | DataReader |
Overrides
ObjectDeserializer.constructor
Defined in
src/rest/restDeserializer.ts:11
Properties
dataExtractor
• Private dataExtractor: null | DataExtractor = null
Defined in
src/rest/restDeserializer.ts:9
dataReader
• Private dataReader: null | DataReader = null
Defined in
src/rest/restDeserializer.ts:7
NON_IDENTIFIED_LOCAL_ID
▪ Static Protected NON_IDENTIFIED_LOCAL_ID: string = '__non_identified__'
Inherited from
ObjectDeserializer.NON_IDENTIFIED_LOCAL_ID
Defined in
src/object/objectDeserializer.ts:39
Methods
configure
▸ configure(config?, override?): void
Parameters
| Name | Type | Default value |
|---|---|---|
config? | Object | undefined |
config.dataExtractor? | null | DataExtractor | undefined |
config.dataReader? | DataReader | undefined |
override | boolean | true |
Returns
void
Overrides
Defined in
src/rest/restDeserializer.ts:17
deserialize
▸ deserialize(data, context): Promise<DeserializedData>
Parameters
| Name | Type |
|---|---|
data | Response |
context | Object |
Returns
Promise<DeserializedData>
Inherited from
ObjectDeserializer.deserialize
Defined in
src/object/objectDeserializer.ts:49
deserializeAttributeValue
▸ Protected deserializeAttributeValue(_instance, def, rawValue, _context): Promise<unknown>
Parameters
| Name | Type |
|---|---|
_instance | ModelInstance |
def | ModelAttribute |
rawValue | unknown |
_context | Object |
Returns
Promise<unknown>
Inherited from
ObjectDeserializer.deserializeAttributeValue
Defined in
src/object/objectDeserializer.ts:432
deserializeRelationValue
▸ Protected deserializeRelationValue(extractedData, instancesMap, instance, def, rawValue, context): Promise<undefined | null | ModelInstance | { $MODEL_TYPE: "instance" ; $loaded: Dictionary<true> ; $model: ModelClass<any> ; $original: ModelSnapshot<any> ; $raw: any ; $values: Partial<ModelValues<any>> ; exists: boolean } & ModelDefinitionWritableValues<any> & Readonly<Pick<ModelDefinitionProperties<any>, string>> & ModelDefinitionDescriptors<any>[] | RestNewResource>
Parameters
| Name | Type |
|---|---|
extractedData | ObjectExtractedData<RestNewResource> |
instancesMap | default<string, ModelIdType, Promise<ModelInstance>> |
instance | ModelInstance |
def | ModelRelation |
rawValue | Optional<RestNewResource | RestNewResource[]> |
context | Object |
Returns
Promise<undefined | null | ModelInstance | { $MODEL_TYPE: "instance" ; $loaded: Dictionary<true> ; $model: ModelClass<any> ; $original: ModelSnapshot<any> ; $raw: any ; $values: Partial<ModelValues<any>> ; exists: boolean } & ModelDefinitionWritableValues<any> & Readonly<Pick<ModelDefinitionProperties<any>, string>> & ModelDefinitionDescriptors<any>[] | RestNewResource>
Inherited from
ObjectDeserializer.deserializeRelationValue
Defined in
src/object/objectDeserializer.ts:443
deserializeResource
▸ Protected deserializeResource(extractedData, instancesMap, resource, context, parent?, relation?): Promise<ModelInstance>
Parameters
| Name | Type |
|---|---|
extractedData | ObjectExtractedData<RestNewResource> |
instancesMap | default<string, ModelIdType, Promise<ModelInstance>> |
resource | RestNewResource |
context | Object |
parent? | ModelInstance |
relation? | ModelRelation |
Returns
Promise<ModelInstance>
Inherited from
ObjectDeserializer.deserializeResource
Defined in
src/object/objectDeserializer.ts:119
deserializeResourceOnInstance
▸ Protected deserializeResourceOnInstance(extractedData, instancesMap, resource, identifier, instance, context): Promise<ModelInstance>
Parameters
| Name | Type |
|---|---|
extractedData | ObjectExtractedData<RestNewResource> |
instancesMap | default<string, ModelIdType, Promise<ModelInstance>> |
resource | RestNewResource |
identifier | ObjectNormalizedIdentifier |
instance | ModelInstance |
context | Object |
Returns
Promise<ModelInstance>
Inherited from
ObjectDeserializer.deserializeResourceOnInstance
Defined in
src/object/objectDeserializer.ts:156
extractAttributeValue
▸ Protected extractAttributeValue(_extractedData, resource, serializedKey, context): Promise<unknown>
Parameters
| Name | Type |
|---|---|
_extractedData | ObjectExtractedData<RestNewResource> |
resource | RestNewResource |
serializedKey | string |
context | Object |
Returns
Promise<unknown>
Inherited from
ObjectDeserializer.extractAttributeValue
Defined in
src/object/objectDeserializer.ts:338
extractData
▸ Protected extractData(response): Promise<ObjectExtractedData<RestNewResource>>
Parameters
| Name | Type |
|---|---|
response | Response |
Returns
Promise<ObjectExtractedData<RestNewResource>>
Inherit Doc
Overrides
ObjectDeserializer.extractData
Defined in
src/rest/restDeserializer.ts:31
extractIdentifier
▸ Protected extractIdentifier(resource, context, parent?, relation?): Promise<ObjectNormalizedIdentifier>
Parameters
| Name | Type |
|---|---|
resource | RestNewResource |
context | Object |
parent? | ModelInstance |
relation? | ModelRelation |
Returns
Promise<ObjectNormalizedIdentifier>
Inherited from
ObjectDeserializer.extractIdentifier
Defined in
src/object/objectDeserializer.ts:218
extractLocalId
▸ Protected extractLocalId(_resource, identifier, _context): Promise<ModelIdType>
Parameters
| Name | Type |
|---|---|
_resource | RestNewResource |
identifier | ObjectNormalizedIdentifier |
_context | Object |
Returns
Promise<ModelIdType>
Inherited from
ObjectDeserializer.extractLocalId
Defined in
src/object/objectDeserializer.ts:248
extractOptionalIdentifier
▸ Protected extractOptionalIdentifier(resource): Promise<RestNewResource>
Parameters
| Name | Type |
|---|---|
resource | RestNewResource |
Returns
Promise<RestNewResource>
Inherit Doc
Overrides
ObjectDeserializer.extractOptionalIdentifier
Defined in
src/rest/restDeserializer.ts:42
extractPropValue
▸ Protected extractPropValue(resource, serializedKey): Promise<unknown>
Parameters
| Name | Type |
|---|---|
resource | RestNewResource |
serializedKey | string |
Returns
Promise<unknown>
Inherit Doc
Overrides
ObjectDeserializer.extractPropValue
Defined in
src/rest/restDeserializer.ts:49
extractRelationValue
▸ Protected extractRelationValue(_extractedData, resource, serializedKey, context): Promise<Optional<RestNewResource | RestNewResource[]>>
Parameters
| Name | Type |
|---|---|
_extractedData | ObjectExtractedData<RestNewResource> |
resource | RestNewResource |
serializedKey | string |
context | Object |
Returns
Promise<Optional<RestNewResource | RestNewResource[]>>
Inherited from
ObjectDeserializer.extractRelationValue
Defined in
src/object/objectDeserializer.ts:347
findInstance
▸ Protected findInstance(_resource, identifier, context): Promise<null | ModelInstance>
Parameters
| Name | Type |
|---|---|
_resource | RestNewResource |
identifier | ObjectNormalizedIdentifier |
context | Object |
Returns
Promise<null | ModelInstance>
Inherited from
ObjectDeserializer.findInstance
Defined in
src/object/objectDeserializer.ts:265
findOrMakeInstance
▸ Protected findOrMakeInstance(resource, identifier, context): Promise<ModelInstance>
Parameters
| Name | Type |
|---|---|
resource | RestNewResource |
identifier | ObjectNormalizedIdentifier |
context | Object |
Returns
Promise<ModelInstance>
Inherited from
ObjectDeserializer.findOrMakeInstance
Defined in
src/object/objectDeserializer.ts:256
hydrateAttributeInInstance
▸ Protected hydrateAttributeInInstance(instance, def, value): Promise<void>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelAttribute |
value | unknown |
Returns
Promise<void>
Inherited from
ObjectDeserializer.hydrateAttributeInInstance
Defined in
src/object/objectDeserializer.ts:369
hydratePropInInstance
▸ Protected hydratePropInInstance(instance, def, value): void
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelRelation | ModelAttribute |
value | unknown |
Returns
void
Inherited from
ObjectDeserializer.hydratePropInInstance
Defined in
src/object/objectDeserializer.ts:360
hydrateRelationInInstance
▸ Protected hydrateRelationInInstance(instance, def, value): Promise<void>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelRelation |
value | unknown |
Returns
Promise<void>
Inherited from
ObjectDeserializer.hydrateRelationInInstance
Defined in
src/object/objectDeserializer.ts:377
initInstancesMap
▸ Protected initInstancesMap(): Promise<default<string, ModelIdType, Promise<ModelInstance>>>
Returns
Promise<default<string, ModelIdType, Promise<ModelInstance>>>
Inherited from
ObjectDeserializer.initInstancesMap
Defined in
src/object/objectDeserializer.ts:83
makeDeserializedData
▸ Protected makeDeserializedData(instances): Promise<{ instances: ModelInstance[] }>
Parameters
| Name | Type |
|---|---|
instances | ModelInstance[] |
Returns
Promise<{ instances: ModelInstance[] }>
Inherit Doc
Overrides
ObjectDeserializer.makeDeserializedData
Defined in
src/rest/restDeserializer.ts:24
makeInstance
▸ Protected makeInstance(_resource, identifier, context): Promise<ModelInstance>
Parameters
| Name | Type |
|---|---|
_resource | RestNewResource |
identifier | ObjectNormalizedIdentifier |
context | Object |
Returns
Promise<ModelInstance>
Inherited from
ObjectDeserializer.makeInstance
Defined in
src/object/objectDeserializer.ts:283
prepareInstancesMap
▸ Protected prepareInstancesMap(extractedData, instancesMap, context): Promise<void>
Parameters
| Name | Type |
|---|---|
extractedData | ObjectExtractedData<RestNewResource> |
instancesMap | default<string, ModelIdType, Promise<ModelInstance>> |
context | Object |
Returns
Promise<void>
Inherited from
ObjectDeserializer.prepareInstancesMap
Defined in
src/object/objectDeserializer.ts:87
releaseInstance
▸ Protected releaseInstance(resource, instance, context): Promise<void>
Parameters
| Name | Type |
|---|---|
resource | RestNewResource |
instance | ModelInstance |
context | Object |
Returns
Promise<void>
Inherited from
ObjectDeserializer.releaseInstance
Defined in
src/object/objectDeserializer.ts:306
serializeAttributeKey
▸ Protected serializeAttributeKey(instance, def, _context): Promise<string>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelAttribute |
_context | Object |
Returns
Promise<string>
Inherited from
ObjectDeserializer.serializeAttributeKey
Defined in
src/object/objectDeserializer.ts:388
serializeRelationKey
▸ Protected serializeRelationKey(instance, def, _context): Promise<string>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelRelation |
_context | Object |
Returns
Promise<string>
Inherited from
ObjectDeserializer.serializeRelationKey
Defined in
src/object/objectDeserializer.ts:396
shouldDeserializeAttribute
▸ Protected shouldDeserializeAttribute(instance, def, rawValue, context): Promise<boolean>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelAttribute |
rawValue | unknown |
context | Object |
Returns
Promise<boolean>
Inherited from
ObjectDeserializer.shouldDeserializeAttribute
Defined in
src/object/objectDeserializer.ts:404
shouldDeserializeProp
▸ Protected shouldDeserializeProp(_instance, def, rawValue, _context): Promise<boolean>
Parameters
| Name | Type |
|---|---|
_instance | ModelInstance |
def | ModelRelation | ModelAttribute |
rawValue | unknown |
_context | Object |
Returns
Promise<boolean>
Inherited from
ObjectDeserializer.shouldDeserializeProp
Defined in
src/object/objectDeserializer.ts:422
shouldDeserializeRelation
▸ Protected shouldDeserializeRelation(instance, def, rawValue, context): Promise<boolean>
Parameters
| Name | Type |
|---|---|
instance | ModelInstance |
def | ModelRelation |
rawValue | unknown |
context | Object |
Returns
Promise<boolean>
Inherited from
ObjectDeserializer.shouldDeserializeRelation
Defined in
src/object/objectDeserializer.ts:413