Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeOrmStorageRef

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _forceReload

_forceReload: boolean = false

Private _isActive

_isActive: boolean = false

Private _prepared

_prepared: boolean = false

Private connections

connections: TypeOrmConnectionWrapper[] = []

Private controller

controller: TypeOrmEntityController

Private isInternalPooled

isInternalPooled: boolean = false

Private isMemoryOnly

isMemoryOnly: boolean = false

Private namespace

namespace: string = ...

Private schemaHandler

schemaHandler: AbstractSchemaHandler

Private singleConnection

singleConnection: boolean = false

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.

Accessors

dbType

  • get dbType(): string

name

  • get name(): string

Methods

addEntityClass

  • addEntityClass(type: Function | IClassRef | ClassType<any>, options?: any): void

addEntityType

  • addEntityType(type: Function | EntitySchema<any>): void

addExtendedStorageRef

addExtendingStorageRef

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

addTableEntityClass

  • addTableEntityClass(type: Function, name: string, options?: EntityOptions): void

applyObjectToStringifiedJsonConversion

  • applyObjectToStringifiedJsonConversion(columns: ColumnMetadataArgs[]): void

closeConnection

  • closeConnection(): Promise<void>

Private closeConnections

  • closeConnections(): Promise<any>

connect

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

forceShutdown

  • forceShutdown(): Promise<void>

getClassRef

  • getClassRef(name: string | Function): IClassRef

getConnection

  • getConnection(): Connection

getController

getEntityClass

  • getEntityClass(ref: string | Function | IClassRef | ClassType<any>): any

getEntityNames

  • getEntityNames(): string[]

getEntityRef

  • getEntityRef(name: string | Function): IEntityRef

getEntityRefs

  • getEntityRefs(): IEntityRef[]

getExtendedStorageRef

getExtendingStorageRef

getFramework

  • getFramework(): string

getMaxListeners

  • getMaxListeners(): number

getName

  • getName(): string

getOptions

getRawCollection

getRawCollectionNames

  • getRawCollectionNames(): Promise<string[]>

getRawCollections

  • getRawCollections(collectionNames: string[]): Promise<ICollection[]>

getSchemaHandler

getType

  • getType(): string

hasEntityClass

  • hasEntityClass(ref: string | Function | IClassRef | ClassType<any>): boolean

isActive

  • isActive(): boolean

isOnlyMemory

  • isOnlyMemory(): boolean

isSingleConnection

  • isSingleConnection(): boolean

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 TypeOrmStorageRef

on

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

populateToExtended

  • populateToExtended(type: Function | EntitySchema<any>): void

prepare

  • prepare(): Promise<boolean>

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

registerEntityRef

  • registerEntityRef(type: string | Function | EntitySchema<any>): void

reload

  • reload(full?: boolean): Promise<boolean>

remove

removeAllListeners

Private removeFromConnectionManager

  • removeFromConnectionManager(): void

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns TypeOrmStorageRef

reset

  • reset(full?: boolean): Promise<any>

setMaxListeners

setOptions

setSchemaHandler

shutdown

  • shutdown(full?: boolean): Promise<void>

size

  • size(): number

wrap

Static Private getClassName

  • getClassName(x: string | Function | EntitySchema<any>): string

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 Private machineName

  • machineName(x: string | Function | EntitySchema<any>): string

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[]>

Generated using TypeDoc