Class PolymorphicSerializer<PrimaryType>

The Serializer class is the main class used to serializer data (you can use the ErrorSerializer class to serialize errors).

Example:

[[include:serializer.example.ts]]

Type Parameters

PrimaryType extends Dictionary<any>

Hierarchy (view full)

Serializer<PrimaryType>
- PolymorphicSerializer

Index

Constructors

constructor

new PolymorphicSerializer<PrimaryType>(commonName, key, serializers): PolymorphicSerializer<PrimaryType>
Type Parameters
- PrimaryType extends Dictionary<any>
Parameters
- commonName: string
- key: keyof PrimaryType
- serializers: Record<string, Serializer<any>>
Returns PolymorphicSerializer<PrimaryType>
Overrides Serializer.constructor
- Defined in src/classes/polymorphic-serialiser.ts:17

Properties

cache

cache: Cache<PrimaryType> = ...

Caching

collectionName

collectionName: string

The name to use for the type.

helpers

helpers: Helpers<PrimaryType>

The set of helper functions for the serializer

`Private` key

key: keyof PrimaryType

`Private` serialisers

serialisers: Record<string, Serializer<any>>

`Static` defaultOptions

defaultOptions: {
    asIncluded: boolean;
    cache: boolean;
    depth: number;
    idKey: string;
    include: number;
    linkers: {};
    metaizers: {};
    nullData: boolean;
    onlyIdentifier: boolean;
    onlyRelationship: boolean;
    projection: null;
    version: string;
} = ...

Default options. Can be edited to change default options globally.

Type declaration

asIncluded: boolean
cache: boolean
depth: number
idKey: string
include: number
linkers: {}
metaizers: {}
nullData: boolean
onlyIdentifier: boolean
onlyRelationship: boolean
projection: null
version: string

Methods

createIdentifier

createIdentifier(data, options?): default
Internal
Generates a ResourceIdentifier.
Parameters
- data: PrimaryType
- Optional options: SerializerOptions<PrimaryType>
Returns default
Overrides Serializer.createIdentifier
- Defined in src/classes/polymorphic-serialiser.ts:42

createResource

createResource(data, options?, helpers?, relatorDataCache?): Promise<default<PrimaryType>>
Internal
Generates a Resource.
Parameters
- data: PrimaryType
- Optional options: Partial<SerializerOptions<PrimaryType>>
- Optional helpers: Helpers<PrimaryType>
- Optional relatorDataCache: Map<Relator<any, any>, Dictionary<any>[]>
Returns Promise<default<PrimaryType>>
Overrides Serializer.createResource
- Defined in src/classes/polymorphic-serialiser.ts:53

getRelators

getRelators(): undefined | Record<string, Relator<PrimaryType, any>>
Gets the Relators associated with this serializer

Returns undefined | Record<string, Relator<PrimaryType, any>>
Inherited from Serializer.getRelators
- Defined in src/classes/serializer.ts:86

`Private` getSerializerForData

getSerializerForData(data): null | Serializer<any>
Parameters
- data: PrimaryType
Returns null | Serializer<any>
- Defined in src/classes/polymorphic-serialiser.ts:77

serialize

serialize(data, options?): Promise<Partial<DataDocument<PrimaryType>>>
The actual serialization function.
Parameters
- data: nullish | SingleOrArray<PrimaryType>
  Data to serialize.
- Optional options: Partial<SerializerOptions<PrimaryType>>
  Options to use at runtime.
Returns Promise<Partial<DataDocument<PrimaryType>>>
Overrides Serializer.serialize
- Defined in src/classes/polymorphic-serialiser.ts:27

`Private` serializeSingle

serializeSingle(data, options?): Promise<Partial<DataDocument<PrimaryType>>>
Parameters
- data: PrimaryType
- Optional options: Partial<SerializerOptions<PrimaryType>>
Returns Promise<Partial<DataDocument<PrimaryType>>>
- Defined in src/classes/polymorphic-serialiser.ts:66

setRelators

setRelators(relators): void
Sets the Relators associated with this serializer
Parameters
- relators: undefined | Relator<PrimaryType, any> | Record<string, Relator<PrimaryType, any>> | Relator<PrimaryType, any>[]
Returns void
Inherited from Serializer.setRelators
- Defined in src/classes/serializer.ts:93

Class PolymorphicSerializer<PrimaryType>

Type Parameters

PrimaryType extends Dictionary<any>

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

PrimaryType extends Dictionary<any>

Parameters

commonName: string

key: keyof PrimaryType

serializers: Record<string, Serializer<any>>

Returns PolymorphicSerializer<PrimaryType>

Properties

cache

collectionName

helpers

Private key

Private serialisers

Static defaultOptions

Type declaration

asIncluded: boolean

cache: boolean

depth: number

idKey: string

include: number

linkers: {}

metaizers: {}

nullData: boolean

onlyIdentifier: boolean

onlyRelationship: boolean

projection: null

version: string

Methods

createIdentifier

Parameters

data: PrimaryType

Optional options: SerializerOptions<PrimaryType>

Returns default

createResource

Parameters

data: PrimaryType

Optional options: Partial<SerializerOptions<PrimaryType>>

Optional helpers: Helpers<PrimaryType>

Optional relatorDataCache: Map<Relator<any, any>, Dictionary<any>[]>

Returns Promise<default<PrimaryType>>

getRelators

Returns undefined | Record<string, Relator<PrimaryType, any>>

Private getSerializerForData

Parameters

data: PrimaryType

Returns null | Serializer<any>

serialize

Parameters

data: nullish | SingleOrArray<PrimaryType>

Optional options: Partial<SerializerOptions<PrimaryType>>

Returns Promise<Partial<DataDocument<PrimaryType>>>

Private serializeSingle

Parameters

data: PrimaryType

Optional options: Partial<SerializerOptions<PrimaryType>>

Returns Promise<Partial<DataDocument<PrimaryType>>>

setRelators

Parameters

relators: undefined | Relator<PrimaryType, any> | Record<string, Relator<PrimaryType, any>> | Relator<PrimaryType, any>[]

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` key

`Private` serialisers

`Static` defaultOptions

`Optional` options: SerializerOptions<PrimaryType>

`Optional` options: Partial<SerializerOptions<PrimaryType>>

`Optional` helpers: Helpers<PrimaryType>

`Optional` relatorDataCache: Map<Relator<any, any>, Dictionary<any>[]>

`Private` getSerializerForData

`Optional` options: Partial<SerializerOptions<PrimaryType>>

`Private` serializeSingle

`Optional` options: Partial<SerializerOptions<PrimaryType>>