IWrappedEntity <T, PK, P>

Index

Methods

• assign
• getSchema
• init
• isInitialized
• isTouched
• populated
• setSchema
• toJSON
• toObject
• toPOJO
• toReference

Methods

assign

• assign(data: EntityData<T> | Partial<EntityDTO<T>>, options?: boolean | AssignOptions): T

• Parameters

  • data: EntityData<T> | Partial<EntityDTO<T>>

  • optionaloptions: boolean | AssignOptions

  Returns T

getSchema

• getSchema(): undefined | string

• Returns undefined | string

init

• init<P>(populated?: boolean, populate?: Populate<T, P>, lockMode?: LockMode, connectionType?: ConnectionType): Promise<Loaded<T, P>>

• Type parameters

  • P: string = never

  Parameters

  • optionalpopulated: boolean

  • optionalpopulate: Populate<T, P>

  • optionallockMode: LockMode

  • optionalconnectionType: ConnectionType

  Returns Promise<Loaded<T, P>>

isInitialized

• isInitialized(): boolean

• Returns boolean

isTouched

• isTouched(): boolean

• Returns boolean

populated

• populated(populated?: boolean): void

• Parameters

  • optionalpopulated: boolean

  Returns void

setSchema

• setSchema(schema?: string): void

• Parameters

  • optionalschema: string

  Returns void

toJSON

• toJSON(...args: any[]): EntityDTO<T>

• Parameters

  • rest...args: any[]

  Returns EntityDTO<T>

toObject

• toObject(ignoreFields?: string[]): EntityDTO<T>

• Parameters

  • optionalignoreFields: string[]

  Returns EntityDTO<T>

toPOJO

• toPOJO(): EntityDTO<T>

• Returns EntityDTO<T>

toReference

• toReference<PK2, P2>(): IdentifiedReference<T, PK2> & LoadedReference<T>

• Type parameters

  • PK2: unknown = PrimaryProperty<T>
  • P2: string = string

  Returns IdentifiedReference<T, PK2> & LoadedReference<T>