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

Represents the base common API all URIStorage Overlays ad-here to

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

EVENT_MOUNTED

EVENT_MOUNTED: IEvent<IMountedEvent> = event<IMountedEvent>()

Event that dispatches whenever the Adapter is mounted

EVENT_UNMOUNTED

EVENT_UNMOUNTED: IEvent<IMountedEvent> = event<IMountedEvent>()

Event that dispatches whenever the Adapter is unmounted

adapter

adapter: BaseAdapter

Represents the Adapter configured to be overlaid

Methods

has_feature

  • has_feature(feature: string): boolean

  • Returns if the currently assigned feature flag is enabled on the configured adapter

    Parameters

    • feature: string

    Returns boolean

is_mounted

  • is_mounted(): boolean

  • Returns if the Overlay is currently mounted

    NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

    Returns boolean

mount

  • mount(): Promise<void>

  • Mounts the Overlay if currently unmounted

    NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

    Returns Promise<void>

unmount

  • unmount(): Promise<void>

  • Unmounts the Overlay if currently mounted

    NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

    Returns Promise<void>

Legend

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

Generated using TypeDoc