Skip to main content
Version: 6.3

IWrappedEntity <Entity>

Index

Methods

assign

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

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

isInitialized

  • isInitialized(): boolean
  • Returns boolean

isManaged

  • isManaged(): boolean
  • Returns boolean

isTouched

  • isTouched(): boolean
  • Returns boolean

populate

  • Type parameters

    • Hint: string = never

    Parameters

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

populated

  • populated(populated?: boolean): void
  • Parameters

    • optionalpopulated: boolean

    Returns void

serialize

  • Type parameters

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

    Parameters

    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>

toPOJO

toReference