Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StorageRef

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private _extending

_extending: IStorageRef[] = []

Private _extends

_extends: IStorageRef[] = []

Private options

options: IStorageOptions = null

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

name

  • get name(): string

Methods

Abstract addEntityClass

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

addExtendedStorageRef

addExtendingStorageRef

addListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

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

Abstract getController

Abstract getEntityNames

  • getEntityNames(): string[]

Abstract getEntityRef

  • getEntityRef(name: string | Function): IEntityRef

Abstract getEntityRefs

  • getEntityRefs(): IEntityRef[]

getExtendedStorageRef

getExtendingStorageRef

Abstract getFramework

  • getFramework(): string

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getName

  • getName(): string

getOptions

Abstract getRawCollection

Abstract getRawCollectionNames

  • getRawCollectionNames(): string[] | Promise<string[]>

Abstract getRawCollections

Abstract getType

  • getType(): string

Abstract hasEntityClass

  • hasEntityClass(cls: string | Function | IClassRef): boolean

Abstract isActive

  • isActive(): 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

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

on

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

Abstract prepare

  • prepare(): boolean | Promise<boolean>

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

rawListeners

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

    • event: string | symbol

    Returns Function[]

Abstract reload

  • reload(): boolean | Promise<boolean>

removeAllListeners

  • removeAllListeners(event?: string | symbol): StorageRef
  • Parameters

    • Optional event: string | symbol

    Returns StorageRef

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns StorageRef

setMaxListeners

  • Parameters

    • n: number

    Returns StorageRef

setOptions

Abstract shutdown

  • shutdown(full?: boolean): void

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

Generated using TypeDoc