mirror of https://github.com/seald/nedb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
267 lines
9.8 KiB
267 lines
9.8 KiB
3 years ago
|
<a name="module_storageBrowser"></a>
|
||
|
|
|
||
|
|
## storageBrowser
|
||
|
|
<p>Way data is stored for this database
|
||
|
|
For a Node.js/Node Webkit database it's the file system
|
||
|
|
For a browser-side database it's localforage which chooses the best option depending on user browser (IndexedDB then WebSQL then localStorage)</p>
|
||
|
|
<p>This version is the browser version</p>
|
||
|
|
|
||
|
|
|
||
|
|
* [storageBrowser](#module_storageBrowser)
|
||
|
|
* _static_
|
||
|
|
* [.existsAsync(file)](#module_storageBrowser.existsAsync) ⇒ <code>Promise.<boolean></code>
|
||
|
|
* [.exists(file, cb)](#module_storageBrowser.exists)
|
||
|
|
* [.renameAsync(oldPath, newPath)](#module_storageBrowser.renameAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.rename(oldPath, newPath, c)](#module_storageBrowser.rename) ⇒ <code>void</code>
|
||
|
|
* [.writeFileAsync(file, data, [options])](#module_storageBrowser.writeFileAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.writeFile(path, data, options, callback)](#module_storageBrowser.writeFile)
|
||
|
|
* [.appendFileAsync(filename, toAppend, [options])](#module_storageBrowser.appendFileAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.appendFile(filename, toAppend, [options], callback)](#module_storageBrowser.appendFile)
|
||
|
|
* [.readFileAsync(filename, [options])](#module_storageBrowser.readFileAsync) ⇒ <code>Promise.<Buffer></code>
|
||
|
|
* [.readFile(filename, options, callback)](#module_storageBrowser.readFile)
|
||
|
|
* [.unlinkAsync(filename)](#module_storageBrowser.unlinkAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.unlink(path, callback)](#module_storageBrowser.unlink)
|
||
|
|
* [.mkdirAsync(path, [options])](#module_storageBrowser.mkdirAsync) ⇒ <code>Promise.<(void\|string)></code>
|
||
|
|
* [.mkdir(path, options, callback)](#module_storageBrowser.mkdir)
|
||
|
|
* [.ensureDatafileIntegrityAsync(filename)](#module_storageBrowser.ensureDatafileIntegrityAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.ensureDatafileIntegrity(filename, callback)](#module_storageBrowser.ensureDatafileIntegrity)
|
||
|
|
* [.crashSafeWriteFileLinesAsync(filename, lines)](#module_storageBrowser.crashSafeWriteFileLinesAsync) ⇒ <code>Promise.<void></code>
|
||
|
|
* [.crashSafeWriteFileLines(filename, lines, [callback])](#module_storageBrowser.crashSafeWriteFileLines)
|
||
|
|
* _inner_
|
||
|
|
* [~existsCallback](#module_storageBrowser..existsCallback) : <code>function</code>
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.existsAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.existsAsync(file) ⇒ <code>Promise.<boolean></code>
|
||
|
|
<p>Returns Promise<true> if file exists</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| file | <code>string</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.exists"></a>
|
||
|
|
|
||
|
|
### storageBrowser.exists(file, cb)
|
||
|
|
<p>Callback returns true if file exists</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| file | <code>string</code> |
|
||
|
|
| cb | [<code>existsCallback</code>](#module_storageBrowser..existsCallback) |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.renameAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.renameAsync(oldPath, newPath) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Moves the item from one path to another</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| oldPath | <code>string</code> |
|
||
|
|
| newPath | <code>string</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.rename"></a>
|
||
|
|
|
||
|
|
### storageBrowser.rename(oldPath, newPath, c) ⇒ <code>void</code>
|
||
|
|
<p>Moves the item from one path to another</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| oldPath | <code>string</code> |
|
||
|
|
| newPath | <code>string</code> |
|
||
|
|
| c | [<code>NoParamCallback</code>](#NoParamCallback) |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.writeFileAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.writeFileAsync(file, data, [options]) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Saves the item at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| file | <code>string</code> |
|
||
|
|
| data | <code>string</code> |
|
||
|
|
| [options] | <code>object</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.writeFile"></a>
|
||
|
|
|
||
|
|
### storageBrowser.writeFile(path, data, options, callback)
|
||
|
|
<p>Saves the item at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| path | <code>string</code> |
|
||
|
|
| data | <code>string</code> |
|
||
|
|
| options | <code>object</code> |
|
||
|
|
| callback | <code>function</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.appendFileAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.appendFileAsync(filename, toAppend, [options]) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Append to the item at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
| toAppend | <code>string</code> |
|
||
|
|
| [options] | <code>object</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.appendFile"></a>
|
||
|
|
|
||
|
|
### storageBrowser.appendFile(filename, toAppend, [options], callback)
|
||
|
|
<p>Append to the item at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
| toAppend | <code>string</code> |
|
||
|
|
| [options] | <code>object</code> |
|
||
|
|
| callback | <code>function</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.readFileAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.readFileAsync(filename, [options]) ⇒ <code>Promise.<Buffer></code>
|
||
|
|
<p>Read data at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
| [options] | <code>object</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.readFile"></a>
|
||
|
|
|
||
|
|
### storageBrowser.readFile(filename, options, callback)
|
||
|
|
<p>Read data at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
| options | <code>object</code> |
|
||
|
|
| callback | <code>function</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.unlinkAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.unlinkAsync(filename) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Remove the data at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.unlink"></a>
|
||
|
|
|
||
|
|
### storageBrowser.unlink(path, callback)
|
||
|
|
<p>Remove the data at given path</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| path | <code>string</code> |
|
||
|
|
| callback | <code>function</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.mkdirAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.mkdirAsync(path, [options]) ⇒ <code>Promise.<(void\|string)></code>
|
||
|
|
<p>Shim for storage.mkdirAsync, nothing to do, no directories will be used on the browser</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| path | <code>string</code> |
|
||
|
|
| [options] | <code>object</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.mkdir"></a>
|
||
|
|
|
||
|
|
### storageBrowser.mkdir(path, options, callback)
|
||
|
|
<p>Shim for storage.mkdir, nothing to do, no directories will be used on the browser</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| path | <code>string</code> |
|
||
|
|
| options | <code>object</code> |
|
||
|
|
| callback | <code>function</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.ensureDatafileIntegrityAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.ensureDatafileIntegrityAsync(filename) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Ensure the datafile contains all the data, even if there was a crash during a full file write
|
||
|
|
Nothing to do, no data corruption possible in the browser</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.ensureDatafileIntegrity"></a>
|
||
|
|
|
||
|
|
### storageBrowser.ensureDatafileIntegrity(filename, callback)
|
||
|
|
<p>Ensure the datafile contains all the data, even if there was a crash during a full file write
|
||
|
|
Nothing to do, no data corruption possible in the browser</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| filename | <code>string</code> | |
|
||
|
|
| callback | [<code>NoParamCallback</code>](#NoParamCallback) | <p>signature: err</p> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.crashSafeWriteFileLinesAsync"></a>
|
||
|
|
|
||
|
|
### storageBrowser.crashSafeWriteFileLinesAsync(filename, lines) ⇒ <code>Promise.<void></code>
|
||
|
|
<p>Fully write or rewrite the datafile, immune to crashes during the write operation (data will not be lost)</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| filename | <code>string</code> |
|
||
|
|
| lines | <code>Array.<string></code> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser.crashSafeWriteFileLines"></a>
|
||
|
|
|
||
|
|
### storageBrowser.crashSafeWriteFileLines(filename, lines, [callback])
|
||
|
|
<p>Fully write or rewrite the datafile, immune to crashes during the write operation (data will not be lost)</p>
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| filename | <code>string</code> | |
|
||
|
|
| lines | <code>Array.<string></code> | |
|
||
|
|
| [callback] | [<code>NoParamCallback</code>](#NoParamCallback) | <p>Optional callback, signature: err</p> |
|
||
|
|
|
||
|
|
<a name="module_storageBrowser..existsCallback"></a>
|
||
|
|
|
||
|
|
### storageBrowser~existsCallback : <code>function</code>
|
||
|
|
**Kind**: inner typedef of [<code>storageBrowser</code>](#module_storageBrowser)
|
||
|
|
|
||
|
|
| Param | Type |
|
||
|
|
| --- | --- |
|
||
|
|
| exists | <code>boolean</code> |
|
||
|
|
|