Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KStor<C>

Type parameters

  • C

Hierarchy

  • EventEmitter
    • KStor

Index

Constructors

constructor

Properties

Private _cache

_cache: any

Private _cwd

_cwd: string = process.cwd()

Private _dirty

_dirty: boolean

Private _loaded

_loaded: boolean

Private _loaded_defaults

_loaded_defaults: boolean

Private _pkg

_pkg: any

Private _writing

_writing: boolean

options

path

path: string

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

db

  • get db(): C
  • set db(data: C): void

iterable

  • get iterable(): object[]
  • For Each Sames as [...instance] here for convenience.

    Returns object[]

size

  • get size(): number
  • Size Gets the size of keys using iterable.

    Returns number

Methods

__@iterator

  • __@iterator(): IterableIterator<object>
  • Iterator

    Returns IterableIterator<object>

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

clear

  • clear(): this
  • Clear Clears the store basically {}

    Returns this

Private createHash

  • createHash(): Buffer

defaults

  • defaults(data: any): this
  • Defaults Ensures defaults in store.

    Parameters

    • data: any

    Returns this

del

  • del(key: string): this
  • Del : Removes a key from the store.

    Parameters

    • key: string

      the key to be removed.

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

Private ensureDefault

  • ensureDefault(val: any, def?: any): any
  • Ensure Default Ensures a default value.

    Parameters

    • val: any

      the value to be inpsected.

    • Default value def: any = null

      the default value if val is undefined.

    Returns any

Private ensureDir

  • ensureDir(): this
  • Ensure Dir Ensures the directory exists.

    Returns this

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

Private exitHandler

  • exitHandler(type: string, codeOrErr: any): void
  • Exit Handler Ensures write finishes before exit.

    Parameters

    • type: string

      the type of exit.

    • codeOrErr: any

      the code or error upon exit.

    Returns void

get

  • get<T>(key: string, def?: any): T
  • Gets value for the provided key.

    Type parameters

    • T

    Parameters

    • key: string

      the key for looking up store value.

    • Optional def: any

      a default value.

    Returns T

getMaxListeners

  • getMaxListeners(): number
  • Returns number

Private getPath

  • Get Path Creates path for persisting data.

    Parameters

    • Optional options: IKStoreOptions

      options to be used for generating path.

    Returns string

has

  • has(key: string): boolean
  • Has Key Checks if store has the specified key.

    Parameters

    • key: string

      the key to inspect.

    Returns boolean

Private hasListener

  • hasListener(key: string): number
  • Has Listener Checks if the Event Emitter contains a listener for the given key.

    Parameters

    • key: string

      the key to inspect eventNames for.

    Returns number

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

Private normalizeKey

  • normalizeKey(key: string): string
  • Normalize Key Normalizes key prefixing with superkey if exists.

    Parameters

    • key: string

      the key to be normalized.

    Returns string

on

  • on(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

set

  • set(key: string | IMap<any>, value?: any): this
  • Set Sets a value for key.

    Parameters

    • key: string | IMap<any>

      the key to set.

    • Optional value: any

      the value to set for specified key.

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

snapshot

  • snapshot(): C
  • Snapshot Gets a snapshot of the store's state.

    Returns C

Private transform

  • transform(data: any): any
  • Transform Runs transform from options.

    Parameters

    • data: any

      the data to be transformed.

    Returns any

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc