uristorage
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the base common API all storage registries implement. Accepting instances of BaseAdapter or BaseOverlay for registeration and lookup

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

EVENT_MOUNTED

EVENT_MOUNTED: IEvent<IRegistryMountEvent<T>> = event<IRegistryMountEvent<T>>()

Event that dispatches whenever a registered IStorage instance is mounted

EVENT_REGISTERED

EVENT_REGISTERED: IEvent<IRegistryRegisterEvent<T>> = event<IRegistryRegisterEvent<T>>()

Event that dispatches whenever a new IStorage instance is registered

EVENT_UNMOUNTED

EVENT_UNMOUNTED: IEvent<IRegistryMountEvent<T>> = event<IRegistryMountEvent<T>>()

Event that dispatches whenever a registered IStorage instance is unmounted

EVENT_UNREGISTERED

EVENT_UNREGISTERED: IEvent<IRegistryRegisterEvent<T>> = event<IRegistryRegisterEvent<T>>()

Event that dispatches whenever a new IStorage instance is unregistered

Readonly size

size: number

Methods

clear

  • clear(): void

delete

  • delete(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

entries

  • entries(): IterableIterator<[string, V]>

forEach

  • forEach(callback: (value: V, key: string, map: Map<string, V>) => void, thisArg?: any): void

  • Parameters

    • callback: (value: V, key: string, map: Map<string, V>) => void
        • (value: V, key: string, map: Map<string, V>): void

        • Parameters

          • value: V
          • key: string
          • map: Map<string, V>

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key: string): V | undefined

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

register

  • register(namespace: string, storage: T): this | Promise<this>

resolve

set

  • set(key: string, value: V): this

unregister

  • unregister(namespace: string): this | Promise<this>

values

  • values(): IterableIterator<V>

Legend

  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Inherited property
  • Inherited method
  • Enumeration

Generated using TypeDoc