Generated using TypeDoc
Dump from transaction level +
Dump from transaction level path +This will only show entries for the current transaction It is intended for diagnostics
-Generated using TypeDoc
Generated using TypeDoc
Causation of the exception Can be used to know what caused this exception
Causation of the exception Can be used to know what caused this exception
this in static methods
https://github.com/microsoft/TypeScript/issues/5863
-Generated using TypeDoc
Generated using TypeDoc
npm run bench
View benchmarks here: https://github.com/MatrixAI/js-db/blob/master/benches/results/WorkerManager.chart.html with https://raw.githack.com/
+View benchmarks here: https://github.com/MatrixAI/js-db/blob/master/benches/results with https://raw.githack.com/
# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
Generated using TypeDoc
Generated using TypeDoc
Asynchronously creates a directory.
The optional options argument can be an integer specifying mode (permission
and sticky bits), or an object with a mode property and a recursiveproperty indicating whether parent directories should be created. CallingfsPromises.mkdir() when path is a directory
diff --git a/docs/modules.html b/docs/modules.html
index 43446e0a..01b2e39f 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1,15 +1,21 @@
-
Crypto utility object Remember ever Node Buffer is an ArrayBuffer
-Custom type for our iterator -This takes over from the outdated AbstractIterator used in abstract-leveldown
-Iterator
+Iterator options
+The keyAsBuffer property controls
+whether DBIterator returns KeyPath as buffers or as strings
+It should be considered to default to true
+The valueAsBuffer property controls value type
+It should be considered to default to true
Path to a key This must be an non-empty array
-Path to a DB level Empty level path refers to the root level
-Plain data dictionary
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Escape is a single \ byte
This is used to escape the separator and literal \
Separator is a single null byte During iteration acquiring a sublevel requires iterating between 0x00 and 0x01
-Escapes the level part for escape and separator
-Escapes the level and key parts for escape and separator
+Wraps ArrayBuffer in Node Buffer with zero copy
-Converts KeyPath to key buffer
e.g. ['A', 'B'] => !A!B (where ! is the sep)
An empty key path is converted to ['']
-Level parts must not contain the separator
+Level parts is allowed to contain the separator
Key actual part is allowed to contain the separator
Converts LevelPath to key buffer e.g. ['A', 'B'] => !A!!B! (where ! is the sep) Level parts must not contain the separator
-Converts key buffer back into KeyPath e.g. !A!!B!C => ['A', 'B', 'C'] (where ! is the sep) Returned parts are always buffers
BNF grammar of key buffer: path => levels:ls keyActual:k -> [...ls, k] | keyActual:k -> [k] levels => level:l levels:ls -> [l, ...ls] | '' -> [] - level => sep .+?:l (?<!escape) sep (?>.+) -> l + level => sep .?:l (?<!escape) sep (?>.) -> l sep => 0x00 escape => 0x5c - keyActual => .+:k -> [k]
-Checks if the separator exists in a string or buffer This only needs to applied to the LevelPath, not the final key
-Slice-copies the Node Buffer to a new ArrayBuffer
-Unescapes the level part of escape and separator
-Generated using TypeDoc
Used to convert possible KeyPath into legal KeyPath
+Unescapes the level and key part of escape and separator
+Generated using TypeDoc
- Preparing search index...
- The search index is not available
@matrixai/dbClass DB
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
__namedParameters: { crypto?: { key: Buffer; ops: Crypto }; dbPath: string; fs: FileSystem; logger: Logger }
Optional crypto?: { key: Buffer; ops: Crypto }
key: Buffer
ops: Crypto
db
fs: FileSystem
logger: Logger
Returns DB
Properties
Readonly [init
Protected _db
Protected Optional crypto
Type declaration
key: Buffer
ops: Crypto
Readonly db
Protected fs
Protected logger
Protected transaction
Protected Optional worker
Accessors
[destroyed]
Returns boolean
[running]
Returns boolean
[status]
Returns Status
db
Returns Readonly<LevelDB<string | Buffer, Buffer>>
Methods
batch
Batches operations together atomically
-Parameters
ops: readonly DBOp[]
Returns Promise<void>
Protected canary
Returns Promise<void>
clear
Parameters
ops: readonly DBOp[]
Returns Promise<void>
Protected canary
Returns Promise<void>
clear
Clear all key values for a specific level This is not atomic, it will iterate over a snapshot of the DB
-Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Deletes a key from the DB
-Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
deserialize
Type parameters
T
Parameters
cipherTextBuf: Buffer
raw: false
Returns Promise<T>
Parameters
cipherTextBuf: Buffer
raw: true
Returns Promise<Buffer>
destroy
Returns Promise<void>
dump
Dump from root level -It is intended for diagnostics
-Parameters
Optional levelPath: readonly (string | Buffer)[]
Optional raw: false
Returns Promise<[string, any][]>
Parameters
levelPath: undefined | readonly (string | Buffer)[]
raw: true
Returns Promise<[Buffer, Buffer][]>
get
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
deserialize
Type parameters
T
Parameters
cipherTextBuf: Buffer
raw: false
Returns Promise<T>
Parameters
cipherTextBuf: Buffer
raw: true
Returns Promise<Buffer>
destroy
Returns Promise<void>
dump
Dump from DB +This will show entries from all levels +It is intended for diagnostics +Use
+console.dirinstead ofconsole.logto debug the result +Setroottotrueif you want to dump from root levelsType parameters
V
Parameters
Optional levelPath: readonly (string | Buffer)[]
Optional raw: false
Optional root: boolean
Returns Promise<[string, V][]>
Parameters
levelPath: undefined | readonly (string | Buffer)[]
raw: true
Optional root: boolean
Returns Promise<[Buffer, Buffer][]>
get
Gets a value from the DB Use raw to return the raw decrypted buffer
-Type parameters
T
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Optional raw: false
Returns Promise<undefined | T>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
raw: true
Returns Promise<undefined | Buffer>
iterator
Type parameters
T
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Optional raw: false
Returns Promise<undefined | T>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
raw: true
Returns Promise<undefined | Buffer>
iterator
Public iterator that works from the data level If keys and values are both false, this iterator will not run at all You must have at least one of them being true or undefined
-Parameters
options: AbstractIteratorOptions<any> & { keys: false; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, undefined>
Parameters
options: AbstractIteratorOptions<any> & { keys: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, Buffer>
Parameters
options: AbstractIteratorOptions<any> & { values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, undefined>
Parameters
Optional options: AbstractIteratorOptions<any>
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, Buffer>
put
Parameters
options: DBIteratorOptions & { keys: false; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, undefined>
Type parameters
V
Parameters
options: DBIteratorOptions & { keys: false; valueAsBuffer: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, V>
Parameters
options: DBIteratorOptions & { keys: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, Buffer>
Parameters
options: DBIteratorOptions & { values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<readonly (string | Buffer)[], undefined>
Type parameters
V
Parameters
options: DBIteratorOptions & { valueAsBuffer: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<readonly (string | Buffer)[], V>
Parameters
Optional options: DBIteratorOptions
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<readonly (string | Buffer)[], Buffer>
put
Put a key and value into the DB Use raw to put raw encrypted buffer
-Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
value: any
Optional raw: false
Returns Promise<void>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
value: Buffer
raw: true
Returns Promise<void>
serialize
Parameters
value: any
raw: false
Returns Promise<Buffer>
Parameters
value: Buffer
raw: true
Returns Promise<Buffer>
set
Parameters
workerManager: DBWorkerManagerInterface
Returns void
Protected setup
Parameters
dbPath: string
Returns Promise<LevelDB<string | Buffer, Buffer>>
Protected setup
Returns Promise<void>
start
Parameters
__namedParameters: { fresh?: boolean } = {}
Optional fresh?: boolean
Returns Promise<void>
stop
Returns Promise<void>
transaction
Returns ResourceAcquire<DBTransaction>
unset
Returns void
with
Type parameters
T
Parameters
f: (tran: DBTransaction) => Promise<T>
Parameters
tran: DBTransaction
Returns Promise<T>
Returns Promise<T>
with
Type parameters
T
TReturn
TNext
Parameters
g: (tran: DBTransaction) => AsyncGenerator<T, TReturn, TNext>
Parameters
tran: DBTransaction
Returns AsyncGenerator<T, TReturn, TNext>
Returns AsyncGenerator<T, TReturn, TNext>
Static createDB
Parameters
__namedParameters: { crypto?: { canary?: Buffer; key: Buffer; ops: Crypto }; dbPath: string; fresh?: boolean; fs?: FileSystem; logger?: Logger }
Optional crypto?: { canary?: Buffer; key: Buffer; ops: Crypto }
Optional canary?: Buffer
key: Buffer
ops: Crypto
db
Optional fresh?: boolean
Optional fs?: FileSystem
Optional logger?: Logger
Returns Promise<DB>
Generated using TypeDoc