From 9fa05be03cbbeaa16209ad3e94e443dee2e0da16 Mon Sep 17 00:00:00 2001 From: Emma Casolin Date: Wed, 25 May 2022 10:37:39 +1000 Subject: [PATCH] Updated docs --- docs/classes/DB.html | 2 +- docs/classes/DBTransaction.html | 2 +- docs/classes/errors.ErrorDB.html | 9 +++++++-- docs/classes/errors.ErrorDBCreate.html | 9 +++++++-- docs/classes/errors.ErrorDBDecrypt.html | 9 +++++++-- docs/classes/errors.ErrorDBDelete.html | 9 +++++++-- docs/classes/errors.ErrorDBDestroyed.html | 9 +++++++-- docs/classes/errors.ErrorDBKey.html | 9 +++++++-- docs/classes/errors.ErrorDBNotRunning.html | 9 +++++++-- docs/classes/errors.ErrorDBParseKey.html | 9 +++++++-- docs/classes/errors.ErrorDBParseValue.html | 9 +++++++-- docs/classes/errors.ErrorDBRunning.html | 9 +++++++-- docs/classes/errors.ErrorDBTransactionCommitted.html | 9 +++++++-- docs/classes/errors.ErrorDBTransactionDestroyed.html | 9 +++++++-- docs/classes/errors.ErrorDBTransactionNotCommited.html | 9 +++++++-- docs/classes/errors.ErrorDBTransactionRollbacked.html | 9 +++++++-- 16 files changed, 100 insertions(+), 30 deletions(-) diff --git a/docs/classes/DB.html b/docs/classes/DB.html index 5de04a87..aab0be2d 100644 --- a/docs/classes/DB.html +++ b/docs/classes/DB.html @@ -1,4 +1,4 @@ -DB | @matrixai/db
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DB

Hierarchy

  • CreateDestroyStartStop
    • DB

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DB(__namedParameters: { crypto?: { key: Buffer; ops: Crypto }; dbPath: string; fs: FileSystem; logger: Logger }): DB

  • Parameters

    • __namedParameters: { crypto?: { key: Buffer; ops: Crypto }; dbPath: string; fs: FileSystem; logger: Logger }
      • Optional crypto?: { key: Buffer; ops: Crypto }
      • dbPath: string
      • fs: FileSystem
      • logger: Logger

    Returns DB

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected _db

_db: LevelDB<string | Buffer, Buffer>

Protected Optional crypto

crypto?: { key: Buffer; ops: Crypto }

Type declaration

Readonly dbPath

dbPath: string

Protected fs

fs: FileSystem

Protected logger

logger: Logger

Protected transactionCounter

transactionCounter: number = 0

Protected Optional workerManager

workerManager?: DBWorkerManagerInterface

Accessors

[destroyed]

  • get [destroyed](): boolean

  • Returns boolean

[running]

  • get [running](): boolean

  • Returns boolean

[status]

  • get [status](): Status

  • Returns Status

db

  • get db(): Readonly<LevelDB<string | Buffer, Buffer>>

  • Returns Readonly<LevelDB<string | Buffer, Buffer>>

Methods

batch

  • batch(ops: readonly DBOp[]): Promise<void>

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBCreate.html b/docs/classes/errors.ErrorDBCreate.html index 17768535..cfe1b38d 100644 --- a/docs/classes/errors.ErrorDBCreate.html +++ b/docs/classes/errors.ErrorDBCreate.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB cannot be created'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBDecrypt.html b/docs/classes/errors.ErrorDBDecrypt.html index 3e5ff5a6..9c8f2739 100644 --- a/docs/classes/errors.ErrorDBDecrypt.html +++ b/docs/classes/errors.ErrorDBDecrypt.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB failed decryption'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBDelete.html b/docs/classes/errors.ErrorDBDelete.html index ef684712..d4baa3dc 100644 --- a/docs/classes/errors.ErrorDBDelete.html +++ b/docs/classes/errors.ErrorDBDelete.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB cannot be deleted'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBDestroyed.html b/docs/classes/errors.ErrorDBDestroyed.html index a296d020..8fec879b 100644 --- a/docs/classes/errors.ErrorDBDestroyed.html +++ b/docs/classes/errors.ErrorDBDestroyed.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB is destroyed'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBKey.html b/docs/classes/errors.ErrorDBKey.html index 0c84a0a1..2ce6197c 100644 --- a/docs/classes/errors.ErrorDBKey.html +++ b/docs/classes/errors.ErrorDBKey.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB key is incorrect'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBNotRunning.html b/docs/classes/errors.ErrorDBNotRunning.html index 1ce4709e..0aaebc23 100644 --- a/docs/classes/errors.ErrorDBNotRunning.html +++ b/docs/classes/errors.ErrorDBNotRunning.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB is not running'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBParseKey.html b/docs/classes/errors.ErrorDBParseKey.html index 158cbdc5..392fa4b8 100644 --- a/docs/classes/errors.ErrorDBParseKey.html +++ b/docs/classes/errors.ErrorDBParseKey.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB key parsing failed'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBParseValue.html b/docs/classes/errors.ErrorDBParseValue.html index 29f76ad0..3b002c33 100644 --- a/docs/classes/errors.ErrorDBParseValue.html +++ b/docs/classes/errors.ErrorDBParseValue.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB value parsing failed'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBRunning.html b/docs/classes/errors.ErrorDBRunning.html index 76abbf6f..3986adf0 100644 --- a/docs/classes/errors.ErrorDBRunning.html +++ b/docs/classes/errors.ErrorDBRunning.html @@ -10,9 +10,14 @@

Static description

description: string = 'DB error'

Static desription

desription: string = 'DB is running'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBTransactionCommitted.html b/docs/classes/errors.ErrorDBTransactionCommitted.html index 43594f75..d7845bde 100644 --- a/docs/classes/errors.ErrorDBTransactionCommitted.html +++ b/docs/classes/errors.ErrorDBTransactionCommitted.html @@ -10,9 +10,14 @@

Static description

description: string = 'DBTransaction is committed'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBTransactionDestroyed.html b/docs/classes/errors.ErrorDBTransactionDestroyed.html index 41d52aca..e9365f1f 100644 --- a/docs/classes/errors.ErrorDBTransactionDestroyed.html +++ b/docs/classes/errors.ErrorDBTransactionDestroyed.html @@ -10,9 +10,14 @@

Static description

description: string = 'DBTransaction is destroyed'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBTransactionNotCommited.html b/docs/classes/errors.ErrorDBTransactionNotCommited.html index 4b824db6..f1101cd4 100644 --- a/docs/classes/errors.ErrorDBTransactionNotCommited.html +++ b/docs/classes/errors.ErrorDBTransactionNotCommited.html @@ -10,9 +10,14 @@

Static description

description: string = 'DBTransaction is not comitted'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>
  • diff --git a/docs/classes/errors.ErrorDBTransactionRollbacked.html b/docs/classes/errors.ErrorDBTransactionRollbacked.html index 15e83c52..644ff5e8 100644 --- a/docs/classes/errors.ErrorDBTransactionRollbacked.html +++ b/docs/classes/errors.ErrorDBTransactionRollbacked.html @@ -10,9 +10,14 @@

Static description

description: string = 'DBTransaction is rollbacked'

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any
  • +

    Parameters

    • err: Error
    • stackTraces: CallSite[]

    Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

description

  • get description(): string

  • Returns string

Methods

toJSON

  • toJSON(): any

  • Encoding to JSON pojo -When overriding this, you can use super.toJSON

    +When overriding this, you can use super.toJSON +The replacer will:

    +
      +
    • delete undefined values in objects
      • +
    • replace undefined values for null in arrays
      • +

    Returns any

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromJSON

  • fromJSON<T>(this: T, json: any): InstanceType<T>