Class Serializer<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> = any

Hierarchy (view full)

Serializer
- PolymorphicSerializer

Index

Constructors

constructor

new Serializer<PrimaryType>(collectionName, options?): Serializer<PrimaryType>
Creates a Serializer.
Type Parameters
- PrimaryType extends Dictionary<any> = any
Parameters
- collectionName: string
  The name of the collection of objects.
- options: Partial<SerializerOptions<PrimaryType>> = {}
  Options for the serializer.
Returns Serializer<PrimaryType>
- Defined in src/classes/serializer.ts:67

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` options

options: SerializerOptions<PrimaryType>

The set of options for the serializer.

`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
- Defined in src/classes/serializer.ts:99

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>>
- Defined in src/classes/serializer.ts:113

getRelators

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

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

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>>>
- Defined in src/classes/serializer.ts:176

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
- Defined in src/classes/serializer.ts:93

Class Serializer<PrimaryType>

Type Parameters

PrimaryType extends Dictionary<any> = any

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

PrimaryType extends Dictionary<any> = any

Parameters

collectionName: string

options: Partial<SerializerOptions<PrimaryType>> = {}

Returns Serializer<PrimaryType>

Properties

cache

collectionName

helpers

Private options

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>>

serialize

Parameters

data: nullish | SingleOrArray<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` options

`Static` defaultOptions

`Optional` options: SerializerOptions<PrimaryType>

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

`Optional` helpers: Helpers<PrimaryType>

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

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