Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ByteDatabase<T>

Type Parameters

  • T extends Data = Data

Hierarchy

  • Emitter<Events>
    • ByteDatabase

Index

Constructors

  • new ByteDatabase<T>(path?: string, options?: DefaultByteProperties): ByteDatabase<T>
  • Type Parameters

    • T extends Data = Data

    Parameters

    • path: string = ':memory:'
    • options: DefaultByteProperties = ...

    Returns ByteDatabase<T>

Properties

[events]: Events
_raw: Database
options: DefaultByteProperties = ...

Methods

  • addListener<K>(event: K, listener: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • listener: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • all(table?: string): T[]
  • Parameters

    • table: string = DEFAULT_TABLE

    Returns T[]

  • delete(key: string, table?: string): RunResult
  • Parameters

    • key: string
    • table: string = DEFAULT_TABLE

    Returns RunResult

  • emit<K>(event: K, ...args: Events[K]): boolean
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • Rest ...args: Events[K]

    Returns boolean

  • eventNames(): string[]
  • Returns string[]

  • find(key: string, table?: string): T
  • Parameters

    • key: string
    • table: string = DEFAULT_TABLE

    Returns T

  • findTables(): any[]
  • Returns any[]

  • getMaxListeners(): number
  • Returns number

  • insert(key: string, val: T, table?: string): RunResult
  • Parameters

    • key: string
    • val: T
    • table: string = DEFAULT_TABLE

    Returns RunResult

  • listenerCount<K>(event: K): number
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K

    Returns number

  • listeners<K>(event: K): EventFunction<Events[K]>[]
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K

    Returns EventFunction<Events[K]>[]

  • off<K>(event: K, fn: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • fn: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • on<K>(event: K, listener: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • listener: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • once<K>(event: K, listener: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • listener: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • prependListener<K>(event: K, listener: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • listener: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • prependOnceListener<K>(event: K, listener: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • listener: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • rawListeners<K>(event: K): EventFunction<Events[K]>[]
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K

    Returns EventFunction<Events[K]>[]

  • Type Parameters

    • K extends "debug"

    Parameters

    • Optional event: K

    Returns ByteDatabase<T>

  • removeListener<K>(event: K, fn: EventFunction<Events[K]>): ByteDatabase<T>
  • Type Parameters

    • K extends "debug"

    Parameters

    • event: K
    • fn: EventFunction<Events[K]>

    Returns ByteDatabase<T>

  • Parameters

    • n: number

    Returns ByteDatabase<T>

  • trySanitize(what: string): string
  • Parameters

    • what: string

    Returns string

  • wipe(table?: string): any
  • Parameters

    • table: string = DEFAULT_TABLE

    Returns any

Generated using TypeDoc