Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeOrmEntityRegistry

Hierarchy

  • DefaultNamespacedRegistry
    • TypeOrmEntityRegistry

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private metadatastore

metadatastore: MetadataArgsStorage = null

Protected Readonly namespace

namespace: string

Static Private _self

_self: TypeOrmEntityRegistry

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

Private _find

Private _findTableMetadataArgs

  • _findTableMetadataArgs(fn: any): TableMetadataArgs

add

  • add<T>(context: string, entry: T): T

addClassRef

  • addClassRef(ref: IClassRef): IClassRef

  • Create default entity reference

    Parameters

    • ref: IClassRef

    Returns IClassRef

addListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

addSchemaToEntityRef

  • addSchemaToEntityRef(schemaRef: string | ISchemaRef, entityRef: IEntityRef, options?: { onlyDefault?: boolean; override?: boolean }): void

  • Parameters

    • schemaRef: string | ISchemaRef
    • entityRef: IEntityRef
    • Optional options: { onlyDefault?: boolean; override?: boolean }
      • Optional onlyDefault?: boolean
      • Optional override?: boolean

    Returns void

clear

  • clear(): void

  • Returns void

create

  • create<T>(context: string, options: ITypeOrmEntityOptions | ITypeOrmPropertyOptions): T

createEmbeddableForOptions

  • createEmbeddableForOptions(options: IObjectOptions): IClassRef

  • Create default entity reference

    Parameters

    • options: IObjectOptions

    Returns IClassRef

createEntity

createEntityForOptions

  • createEntityForOptions(options: IEntityOptions): DefaultEntityRef

  • Create default entity reference

    Parameters

    • options: IEntityOptions

    Returns DefaultEntityRef

createPropertiesForRef

  • createPropertiesForRef(clsRef: IClassRef): DefaultPropertyRef[]

  • Create properties for class or entity ref.

    Parameters

    • clsRef: IClassRef

    Returns DefaultPropertyRef[]

createPropertyByArgs

  • createPropertyByArgs(type: "column" | "relation" | "embedded", args: ColumnMetadataArgs | RelationMetadataArgs | EmbeddedMetadataArgs, recursive?: boolean): TypeOrmPropertyRef

createPropertyForOptions

  • createPropertyForOptions(options: IPropertyOptions): DefaultPropertyRef

  • Create default property reference

    Parameters

    • options: IPropertyOptions

    Returns DefaultPropertyRef

createSchemaForOptions

  • createSchemaForOptions(options: ISchemaOptions): SchemaRef

  • Create default schema reference

    Parameters

    • options: ISchemaOptions

    Returns SchemaRef

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

filter

  • filter<T>(context: string, search: any): T[]

  • TODO

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T[]

find

  • find<T>(context: string, search: any): T

  • TODO

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T

Private findTable

  • findTable(f: (x: TableMetadataArgs) => boolean): TableMetadataArgs

fromJsonSchema

  • fromJsonSchema(json: any): Promise<IEntityRef | IClassRef | (IEntityRef | IClassRef)[]>

getClassRefFor

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

  • Parameters

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

    Returns IClassRef

getEntities

  • getEntities(filter?: (x: IEntityRef) => boolean): IEntityRef[]

  • TODO

    Parameters

    • Optional filter: (x: IEntityRef) => boolean
        • (x: IEntityRef): boolean

        • Parameters

          • x: IEntityRef

          Returns boolean

    Returns IEntityRef[]

getEntityRefByName

getEntityRefFor

  • getEntityRefFor(instance: string | object | Function, skipNsCheck?: boolean): TypeOrmEntityRef

getEntityRefs

getGlobal

  • getGlobal(): (Window & typeof globalThis) | (Global & typeof globalThis)

getLookupRegistry

  • getLookupRegistry(): LookupRegistry

  • Returns the used instance of lookup registry handler

    Returns LookupRegistry

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getMetadata

  • getMetadata(context: METADATA_TYPE, target: string | Function, propertyName?: string): IAbstractOptions

  • Return metadata collected in the MetadataRegistry through annotation or explizit attached data.

    Parameters

    • context: METADATA_TYPE
    • target: string | Function
    • Optional propertyName: string

    Returns IAbstractOptions

    IAbstractOptions

getPropertyRef

  • getPropertyRef(ref: IEntityRef | IClassRef, name: string): DefaultPropertyRef

  • Returns property by name for a given class or entity ref

    Parameters

    • ref: IEntityRef | IClassRef
    • name: string

    Returns DefaultPropertyRef

getPropertyRefs

getPropertyRefsFor

getSchemaRefs

  • getSchemaRefs(filter?: (x: ISchemaRef) => boolean): SchemaRef[]

  • Return all registered schema references

    Parameters

    • Optional filter: (x: ISchemaRef) => boolean
        • (x: ISchemaRef): boolean

        • Parameters

          • x: ISchemaRef

          Returns boolean

    Returns SchemaRef[]

    ISchemaRef[]

getSchemaRefsFor

  • getSchemaRefsFor(ref: string): SchemaRef

  • Return schema references for an given entity or class reference

    Parameters

    • ref: string

    Returns SchemaRef

    ISchemaRef[]

list

  • list<X>(type: METADATA_TYPE, filter?: (x: any) => boolean): X[]

  • Type parameters

    • X

    Parameters

    • type: METADATA_TYPE
    • Optional filter: (x: any) => boolean
        • (x: any): boolean

        • Parameters

          • x: any

          Returns boolean

    Returns X[]

listEntities

  • listEntities(filter?: (x: IEntityRef) => boolean): IEntityRef[]

  • Parameters

    • Optional filter: (x: IEntityRef) => boolean
        • (x: IEntityRef): boolean

        • Parameters

          • x: IEntityRef

          Returns boolean

    Returns IEntityRef[]

listProperties

  • listProperties(filter?: (x: IPropertyRef) => boolean): IPropertyRef[]

  • Parameters

    • Optional filter: (x: IPropertyRef) => boolean
        • (x: IPropertyRef): boolean

        • Parameters

          • x: IPropertyRef

          Returns boolean

    Returns IPropertyRef[]

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

on

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

onAdd

  • onAdd(context: METADATA_TYPE, options: ITypeOrmEntityOptions | ITypeOrmPropertyOptions | ISchemaOptions | IObjectOptions): void

onMetaDataPush

  • onMetaDataPush(key: TYPEORM_METADATA_KEYS, ...args: any[]): void

onMetaDataSplice

  • onMetaDataSplice(key: TYPEORM_METADATA_KEYS, ...args: any[]): void

onRemove

  • onRemove(context: METADATA_TYPE, entries: (IPropertyOptions | IEntityOptions | ISchemaOptions | IObjectOptions)[]): void

onUpdate

  • onUpdate(): void

once

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

prepare

  • prepare(): void

  • Initialize events for metadata changes on runtime

    Returns void

prependListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

prependOnceListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

register

  • register(xsdef: AbstractRef): AbstractRef

remove

  • remove<T>(context: string, search: any): T[]

  • TODO

    Type parameters

    • T

    Parameters

    • context: string
    • search: any

    Returns T[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns TypeOrmEntityRegistry

removeListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmEntityRegistry

reset

  • reset(): void

setMaxListeners

  • Parameters

    • n: number

    Returns TypeOrmEntityRegistry

Static $

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Static reset

  • reset(): void

Generated using TypeDoc