IWrappedEntity <Entity>

Index

Methods

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

Methods

assign

• assign<Naked, Convert, Data>(data: Data & IsSubset<EntityData<Naked, Convert>, Data>, options?: AssignOptions<Convert>): MergeSelected<Entity, Naked, keyof Data & string>

• Type parameters

  • Naked: unknown = FromEntityType<Entity>
  • Convert: boolean = false
  • Data: EntityData<Naked, Convert> | Partial<EntityDTO<Naked, never>> = EntityData<Naked, Convert> | Partial<EntityDTO<Naked, never>>

  Parameters

  • data: Data & IsSubset<EntityData<Naked, Convert>, Data>

  • optionaloptions: AssignOptions<Convert>

  Returns MergeSelected<Entity, Naked, keyof Data & string>

getSchema

• getSchema(): undefined | string

• Returns undefined | string

init

• init<Hint, Fields, Excludes>(options?: FindOneOptions<Entity, Hint, Fields, Excludes>): Promise<null | Loaded<Entity, Hint, Fields, Excludes>>

• Type parameters

  • Hint: string = never
  • Fields: string = *
  • Excludes: string = never

  Parameters

  • optionaloptions: FindOneOptions<Entity, Hint, Fields, Excludes>

  Returns Promise<null | Loaded<Entity, Hint, Fields, Excludes>>

isInitialized

• isInitialized(): boolean

• Returns boolean

isManaged

• isManaged(): boolean

• Returns boolean

isTouched

• isTouched(): boolean

• Returns boolean

populate

• populate<Hint>(populate: false | AutoPath<Entity, Hint, never, 9>[], options?: EntityLoaderOptions<Entity>): Promise<Loaded<Entity, Hint, *, never>>

• Type parameters

  • Hint: string = never

  Parameters

  • populate: false | AutoPath<Entity, Hint, never, 9>[]

  • optionaloptions: EntityLoaderOptions<Entity>

  Returns Promise<Loaded<Entity, Hint, *, never>>

populated

• populated(populated?: boolean): void

• Parameters

  • optionalpopulated: boolean

  Returns void

serialize

• serialize<Hint, Exclude>(options?: SerializeOptions<Entity, Hint, Exclude>): EntityDTO<Loaded<Entity, Hint, *, never>, never>

• Type parameters

  • Hint: string = never
  • Exclude: string = never

  Parameters

  • optionaloptions: SerializeOptions<Entity, Hint, Exclude>

  Returns EntityDTO<Loaded<Entity, Hint, *, never>, never>

setSchema

• setSchema(schema?: string): void

• Parameters

  • optionalschema: string

  Returns void

toJSON

• toJSON(...args: any[]): EntityDTO<Entity, never>

• Parameters

  • rest...args: any[]

  Returns EntityDTO<Entity, never>

toObject

• toObject(): EntityDTO<Entity, never>
• toObject(ignoreFields: never[]): EntityDTO<Entity, never>
• toObject<Ignored>(ignoreFields: Ignored[]): Omit<EntityDTO<Entity, never>, Ignored>

• Returns EntityDTO<Entity, never>

toPOJO

• toPOJO(): EntityDTO<Entity, never>

• Returns EntityDTO<Entity, never>

toReference

• toReference(): Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>, *, never>>

• Returns Ref<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>, *, never>>