SerializationContext <T>

Helper that allows to keep track of where we are currently at when serializing complex entity graph with cycles. Before we process a property, we call visit that checks if it is not a cycle path (but allows to pass cycles that are defined in populate hint). If not, we proceed and call leave afterwards.

Index

Constructors

• constructor

Properties

• path
• visited

Methods

• close
• isMarkedAsPopulated
• isPartiallyLoaded
• leave
• visit
• propagate

Constructors

constructor

• new SerializationContext<T>(config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>, populate?: PopulateOptions<T>[], fields?: Set<string>, exclude?: string[]): SerializationContext<T>

• Type parameters

  • T

  Parameters

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  • populate: PopulateOptions<T>[] = []

  • optionalfields: Set<string>

  • optionalexclude: string[]

  Returns SerializationContext<T>

Properties

readonlypath

path: [string, string][] = []

readonlyvisited

visited: Set<Partial<any>> = ...

Methods

close

• close(): void

• Returns void

isMarkedAsPopulated

• isMarkedAsPopulated(entityName: string, prop: string): boolean

• Parameters

  • entityName: string

  • prop: string

  Returns boolean

isPartiallyLoaded

• isPartiallyLoaded(entityName: string, prop: string): boolean

• Parameters

  • entityName: string

  • prop: string

  Returns boolean

leave

• leave<U>(entityName: string, prop: string): void

• Type parameters

  • U

  Parameters

  • entityName: string

  • prop: string

  Returns void

visit

• visit(entityName: string, prop: string): boolean

• Returns true when there is a cycle detected.

  ---

  Parameters

  • entityName: string

  • prop: string

  Returns boolean

staticpropagate

• propagate(root: SerializationContext<Partial<any>>, entity: Partial<any>, isVisible: (meta: EntityMetadata<any>, prop: string) => boolean): void

• When initializing new context, we need to propagate it to the whole entity graph recursively.

  ---

  Parameters

  • root: SerializationContext<Partial<any>>

  • entity: Partial<any>

  • isVisible: (meta: EntityMetadata<any>, prop: string) => boolean

  Returns void