Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Adapter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

listeners

listeners: EventListener[] = []

Accessors

maxListeners

  • get maxListeners(): number
  • set maxListeners(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

name

  • get name(): string
  • set name(name: string): void

Methods

Abstract createCollection

  • createCollection(name: string): Promise<boolean>
  • createCollection(name: string): Promise<boolean>

  • Create a collection to store records.

    Parameters

    • name: string

    Returns Promise<boolean>

  • Parameters

    • name: string

    Returns Promise<boolean>

Abstract dropCollection

  • dropCollection(name: string): Promise<boolean>
  • dropCollection(name: string): Promise<boolean>

  • Drop a collection.

    Parameters

    • name: string

    Returns Promise<boolean>

  • Parameters

    • name: string

    Returns Promise<boolean>

emit

  • emit(namespace: string, ...data: any[]): void

  • Parameters

    • namespace: string
    • Rest ...data: any[]

    Returns void

Abstract ensureCollectionExists

  • ensureCollectionExists(name: string): Promise<boolean>
  • ensureCollectionExists(name: string): Promise<boolean>

  • Ensure that a collection exists. This method must be guaranteed not to throw if the collection already exists.

    Parameters

    • name: string

    Returns Promise<boolean>

  • Parameters

    • name: string

    Returns Promise<boolean>

Abstract findAll

Abstract get

  • get(collection: string, id: string): Promise<RecordData>
  • get(collection: string, id: string): Promise<RecordData>

Abstract getCollectionNames

  • getCollectionNames(): Promise<string[]>
  • getCollectionNames(): Promise<string[]>

  • Get the name of each collection already defined.

    Returns Promise<string[]>

  • Returns Promise<string[]>

Abstract insert

Abstract insertAll

load

  • load(): Promise<boolean>
  • load(): Promise<boolean>

  • Establish a connection and/or do anything needed in order to accept queries.

    Returns Promise<boolean>

  • Returns Promise<boolean>

on

  • on(namespace: string | RegExp, callback: Function, once?: boolean): EventListener

  • Subscribe a callable function to a namespace.

    Parameters

    • namespace: string | RegExp
    • callback: Function
    • Default value once: boolean = false

    Returns EventListener

    Used to manage the subscription status via open and close methods.

once

  • once(namespace: string | RegExp, callback: Function): EventListener

  • Subscribe a callable function to a namespace, for exactly one execution.

    Parameters

    • namespace: string | RegExp
    • callback: Function

    Returns EventListener

    Used to manage the subscription status via open and close methods.

pop

  • pop(listener: EventListener): boolean

  • Remove a Listener instance from the EventNamespace instance. Called with unsubscribe method.

    Parameters

    • listener: EventListener

    Returns boolean

    A true value indicates a successful pop.

push

  • push(listener: EventListener): void

  • Add a Listener instance to the EventNamespace instance. Called with subscribe method.

    Parameters

    • listener: EventListener

    Returns void

Abstract remove

  • remove(collection: string, id: string): Promise<RecordData>
  • remove(collection: string, id: string): Promise<RecordData>

Abstract replace

Abstract truncateCollection

  • truncateCollection(name: string): Promise<boolean>
  • truncateCollection(name: string): Promise<boolean>

  • Remove all records from the collection, but keep the collection itself and all related settings.

    Parameters

    • name: string

    Returns Promise<boolean>

  • Parameters

    • name: string

    Returns Promise<boolean>

Abstract update