Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeOrmEntityRef

Hierarchy

  • DefaultEntityRef
    • TypeOrmEntityRef

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly metaType

metaType: METADATA_TYPE

Readonly name

name: string

namespace

namespace: string

Readonly object

object: IClassRef

Accessors

machineName

  • get machineName(): string

  • Returns string

metadata

  • get metadata(): any

storingName

  • get storingName(): string

  • Return machine compatible name for the entity in snake-case style.

    Returns string

Methods

build

  • build<T>(instance: any, options?: IBuildOptions): T

  • Type parameters

    • T

    Parameters

    • instance: any
    • Optional options: IBuildOptions

    Returns T

create

  • create<T>(): T

  • Type parameters

    • T

    Returns T

getClass

  • getClass(create?: boolean): Function

  • Parameters

    • Optional create: boolean

    Returns Function

getClassRef

  • getClassRef(): IClassRef

  • Returns IClassRef

getClassRefFor

  • getClassRefFor(object: string | Function | IClassRef, type: METADATA_TYPE): IClassRef

  • Parameters

    • object: string | Function | IClassRef
    • type: METADATA_TYPE

    Returns IClassRef

getNamespace

  • getNamespace(): string

  • Returns string

getOptions

  • getOptions(key?: string, defaultValue?: any): any

  • Parameters

    • Optional key: string
    • Optional defaultValue: any

    Returns any

Protected getOptionsEntry

  • getOptionsEntry(): any

  • Returns any

getPropertyRef

  • getPropertyRef(name: string): IPropertyRef

  • Parameters

    • name: string

    Returns IPropertyRef

getPropertyRefs

  • getPropertyRefs(): IPropertyRef[]

  • Returns IPropertyRef[]

getRegistry

  • getRegistry(): ILookupRegistry

  • Returns ILookupRegistry

getSchemaRefs

  • getSchemaRefs(): SchemaRef | SchemaRef[]

  • Returns SchemaRef | SchemaRef[]

getSourceRef

  • getSourceRef(): IClassRef

  • Returns IClassRef

hasOption

  • hasOption(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

id

  • id(): string

isOf

  • isOf(instance: any): boolean

  • Check if an object / instance is of same type like this entity ref (same check as IClassRef.isOf).

    Parameters

    • instance: any

    Returns boolean

setOption

  • setOption(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

setOptions

  • setOptions(options: any): void

  • Parameters

    • options: any

    Returns void

toJsonSchema

  • toJsonSchema(options?: IJsonSchemaSerializeOptions): IJsonSchema7

Generated using TypeDoc