Class Formatter

Every query resolving gets its own formatter.

Hierarchy

Formatter

Constructors

constructor

new Formatter(rootClassSchema: ReflectionClass<any>, serializer: Serializer, hydrator?: HydratorFn, identityMap?: IdentityMap): Formatter
Parameters
- rootClassSchema: ReflectionClass<any>
- serializer: Serializer
- Optional hydrator: HydratorFn
- Optional identityMap: IdentityMap
Returns Formatter
- Defined in packages/orm/src/formatter.ts:62

Properties

`Protected` deserialize

deserialize: SerializeFunction

`Protected` `Optional` hydrator

hydrator?: HydratorFn

`Protected` `Optional` identityMap

identityMap?: IdentityMap

`Protected` instancePools

instancePools: Map<ClassType<any>, Map<string, any>> = ...

`Protected` partialDeserialize

partialDeserialize: SerializeFunction

`Protected` referenceClasses

referenceClasses: Map<ReflectionClass<any>, ClassType<any>> = ...

`Protected` rootClassSchema

rootClassSchema: ReflectionClass<any>

`Protected` rootClassState

rootClassState: ClassState<any> = ...

`Protected` rootPkHash

rootPkHash: ((value: any) => string) = ...

Type declaration

- (value: any): string
- Parameters
  - value: any
  Returns string

`Protected` serializer

serializer: Serializer

withIdentityMap

withIdentityMap: boolean = true

Methods

`Protected` assignJoins

assignJoins(model: DatabaseQueryModel<any, any, any>, classSchema: ReflectionClass<any>, dbRecord: DBRecord, item: any): {
[name: string]: true;
}
Parameters
- model: DatabaseQueryModel<any, any, any>
- classSchema: ReflectionClass<any>
- dbRecord: DBRecord
- item: any
Returns {
[name: string]: true;
}
- [name: string]: true
- Defined in packages/orm/src/formatter.ts:273

`Protected` createObject

createObject(model: DatabaseQueryModel<any, any, any>, classState: ClassState<any>, classSchema: ReflectionClass<any>, dbRecord: DBRecord): any
Parameters
- model: DatabaseQueryModel<any, any, any>
- classState: ClassState<any>
- classSchema: ReflectionClass<any>
- dbRecord: DBRecord
Returns any
- Defined in packages/orm/src/formatter.ts:319

`Protected` getInstancePoolForClass

getInstancePoolForClass(classType: ClassType<any>): Map<string, any>
Parameters
- classType: ClassType<any>
Returns Map<string, any>
- Defined in packages/orm/src/formatter.ts:72

`Protected` getReference

getReference(classSchema: ReflectionClass<any>, dbRecord: DBRecord, propertySchema: ReflectionProperty, isPartial: boolean): undefined | null | object
Parameters
- classSchema: ReflectionClass<any>
- dbRecord: DBRecord
- propertySchema: ReflectionProperty
- isPartial: boolean
Returns undefined | null | object
- Defined in packages/orm/src/formatter.ts:125

`Protected` getReferenceClass

getReferenceClass<T>(classSchema: ReflectionClass<T>): ClassType<T>
Type Parameters
- T
Parameters
- classSchema: ReflectionClass<T>
Returns ClassType<T>
- Defined in packages/orm/src/formatter.ts:111

hydrate

hydrate<T>(model: DatabaseQueryModel<T, any, any>, dbRecord: DBRecord): any
Type Parameters
- T extends OrmEntity
Parameters
- model: DatabaseQueryModel<T, any, any>
- dbRecord: DBRecord
Returns any
- Defined in packages/orm/src/formatter.ts:80

`Protected` hydrateModel

hydrateModel(model: DatabaseQueryModel<any, any, any>, classSchema: ReflectionClass<any>, dbRecord: DBRecord): any
Parameters
- model: DatabaseQueryModel<any, any, any>
- classSchema: ReflectionClass<any>
- dbRecord: DBRecord
Returns any
- Defined in packages/orm/src/formatter.ts:174

`Protected` makeInvalidReference

makeInvalidReference(item: any, classSchema: ReflectionClass<any>, propertySchema: ReflectionProperty): void
Parameters
- item: any
- classSchema: ReflectionClass<any>
- propertySchema: ReflectionProperty
Returns void
- Defined in packages/orm/src/formatter.ts:84

Class Formatter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rootClassSchema: ReflectionClass<any>

serializer: Serializer

Optional hydrator: HydratorFn

Optional identityMap: IdentityMap

Returns Formatter

Properties

Protected deserialize

Protected Optional hydrator

Protected Optional identityMap

Protected instancePools

Protected partialDeserialize

Protected referenceClasses

Protected rootClassSchema

Protected rootClassState

Protected rootPkHash

Type declaration

Parameters

value: any

Returns string

Protected serializer

withIdentityMap

Methods

Protected assignJoins

Parameters

model: DatabaseQueryModel<any, any, any>

classSchema: ReflectionClass<any>

dbRecord: DBRecord

item: any

Returns { [name: string]: true; }

[name: string]: true

Protected createObject

Parameters

model: DatabaseQueryModel<any, any, any>

classState: ClassState<any>

classSchema: ReflectionClass<any>

dbRecord: DBRecord

Returns any

Protected getInstancePoolForClass

Parameters

classType: ClassType<any>

Returns Map<string, any>

Protected getReference

Parameters

classSchema: ReflectionClass<any>

dbRecord: DBRecord

propertySchema: ReflectionProperty

isPartial: boolean

Returns undefined | null | object

Protected getReferenceClass

Type Parameters

T

Parameters

classSchema: ReflectionClass<T>

Returns ClassType<T>

hydrate

Type Parameters

T extends OrmEntity

Parameters

model: DatabaseQueryModel<T, any, any>

dbRecord: DBRecord

Returns any

Protected hydrateModel

Parameters

model: DatabaseQueryModel<any, any, any>

classSchema: ReflectionClass<any>

dbRecord: DBRecord

Returns any

Protected makeInvalidReference

Parameters

item: any

classSchema: ReflectionClass<any>

`Optional` hydrator: HydratorFn

`Optional` identityMap: IdentityMap

`Protected` deserialize

`Protected` `Optional` hydrator

`Protected` `Optional` identityMap

`Protected` instancePools

`Protected` partialDeserialize

`Protected` referenceClasses

`Protected` rootClassSchema

`Protected` rootClassState

`Protected` rootPkHash

`Protected` serializer

`Protected` assignJoins

Returns {
[name: string]: true;
}

`Protected` createObject

`Protected` getInstancePoolForClass

`Protected` getReference

`Protected` getReferenceClass

`Protected` hydrateModel

`Protected` makeInvalidReference