abstractBaseEntity

Index

Constructors

• constructor

Methods

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

Constructors

constructor

• new BaseEntity(): BaseEntity

• Returns BaseEntity

Methods

assign

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

• Type parameters

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

  Parameters

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

  • options: AssignOptions<Convert> = {}

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

getSchema

• getSchema(): undefined | string

• Returns undefined | string

init

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

• Type parameters

  • Entity: BaseEntity = BaseEntity
  • 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

isTouched

• isTouched(): boolean

• Returns boolean

populate

• populate<Entity, Hint>(populate, options): Promise<Loaded<Entity, Hint>>

• Type parameters

  • Entity: BaseEntity = BaseEntity
  • Hint: string = never

  Parameters

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

  • options: EntityLoaderOptions<Entity> = {}

  Returns Promise<Loaded<Entity, Hint>>

populated

• populated(populated): void

• Parameters

  • populated: boolean = true

  Returns void

serialize

• serialize<Entity, Hint, Exclude>(options): EntityDTO<Loaded<Entity, Hint>>

• Type parameters

  • Entity: BaseEntity = BaseEntity
  • Hint: string = never
  • Exclude: string = never

  Parameters

  • optionaloptions: SerializeOptions<Entity, Hint, Exclude>

  Returns EntityDTO<Loaded<Entity, Hint>>

setSchema

• setSchema(schema): void

• Parameters

  • optionalschema: string

  Returns void

toObject

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

• Type parameters

  • Entity: BaseEntity = BaseEntity

  Returns EntityDTO<Entity>

toPOJO

• toPOJO<Entity>(): EntityDTO<Entity>

• Type parameters

  • Entity: BaseEntity = BaseEntity

  Returns EntityDTO<Entity>

toReference

• toReference<Entity>(): Reference<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>

• Type parameters

  • Entity: BaseEntity = BaseEntity

  Returns Reference<Entity> & LoadedReference<Loaded<Entity, AddEager<Entity>>>