Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IStorageRef

Abstract interface for storage declaration

Hierarchy

  • IStorageRef

Implemented by

Index

Methods

addEntityClass

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

addExtendedStorageRef

addExtendingStorageRef

connect

getController

getEntityNames

  • getEntityNames(): string[]

getEntityRef

  • getEntityRef(name: string | Function): IEntityRef | IEntityRef[]

getEntityRefs

  • getEntityRefs(): IEntityRef[]

getFramework

  • getFramework(): string

getName

  • getName(): string

getOptions

getRawCollection

getRawCollectionNames

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

getRawCollections

getType

  • getType(): string

hasEntityClass

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

isActive

  • isActive(): boolean

prepare

  • prepare(): boolean | Promise<boolean>

reload

  • reload(): boolean | Promise<boolean>

shutdown

  • shutdown(full?: boolean): void
  • onShutdown function to finalize this storage ref (close opened connection and release resources)

    Parameters

    • Optional full: boolean

      marks if onShutdown is soft (close on runtime) or hard (onShutdown of program)

    Returns void

Generated using TypeDoc