1. module lowdb
   1. function lowdb (source)
   2. object lowdb.browser
   3. object lowdb.common
   4. object lowdb.file_async
   5. object lowdb.file_sync
   6. object lowdb.memory
2. module lowdb.browser
   1. function lowdb.browser.read (source)
   2. function lowdb.browser.write (dest, obj)
3. module lowdb.common
   1. function lowdb.common.init (db, key, source)
4. module lowdb.file_async
   1. function lowdb.file_async.read (source)
   2. function lowdb.file_async.write (dest, obj)
5. module lowdb.file_sync
   1. function lowdb.file_sync.read (source)
   2. function lowdb.file_sync.write (dest, obj)
6. module lowdb.memory
   1. function lowdb.memory.read ()
   2. function lowdb.memory.write ()

module lowdb

function lowdb (source)

• description and source-code

  lowdb = function (source) {
    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
  
    // Create a fresh copy of lodash
    var _ = lodash.runInContext();
    var db = _.chain({});
  
    // Expose _ for mixins
    db._ = _;
  
    // Add write function to lodash
    // Calls save before returning result
    _.prototype.write = _.wrap(_.prototype.value, function (func) {
      var dest = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : source;
  
      var funcRes = func.apply(this);
      return db.write(dest, funcRes);
    });
  
    return common.init(db, '__wrapped__', source, opts);
  }

• example usage

  n/a

module lowdb.browser

function lowdb.browser.read (source)

• description and source-code

  function browserRead(source) {
    var deserialize = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : JSON.parse;
  
    var data = localStorage.getItem(source);
    if (data) {
      return deserialize(data);
    } else {
      localStorage.setItem(source, '{}');
      return {};
    }
  }

• example usage

  ...
  
  ```js
  const db = low('db.json')
  db.write()            // writes to db.json
  db.write('copy.json') // writes to copy.json
  ```
  
  __db.read([source])__
  
  Reads source using `storage.read` option. Depending on the storage, it may return a promise.
  
  ```js
  const db = low('db.json')
  db.read()            // reads db.json
  db.read('copy.json') // reads copy.json
  ...

function lowdb.browser.write (dest, obj)

• description and source-code

  function browserWrite(dest, obj) {
    var serialize = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : stringify;
  
    localStorage.setItem(dest, serialize(obj));
  }

• example usage

  ...
  > A small local database powered by lodash API
  
  ```js
  const db = low('db.json')
  
  // Set some defaults if your JSON file is empty
  db.defaults({ posts: [], user: {} })
    .write()
  
  // Add a post
  db.get('posts')
    .push({ id: 1, title: 'lowdb is awesome'})
    .write()
  
  // Set a user
  ...

module lowdb.common

function lowdb.common.init (db, key, source)

• description and source-code

  function init(db, key, source) {
    var _ref = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {},
        _ref$storage = _ref.storage,
        storage = _ref$storage === undefined ? defaultStorage : _ref$storage,
        _ref$format = _ref.format,
        format = _ref$format === undefined ? {} : _ref$format;
  
    db.source = source;
  
    // Set storage
    // In-memory only if no source is provided
    db.storage = _extends({}, memory, db.source && storage);
  
    db.read = function () {
      var s = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : source;
  
      var r = db.storage.read(s, format.deserialize);
  
      return isPromise(r) ? r.then(db.plant) : db.plant(r);
    };
  
    db.write = function () {
      var dest = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : source;
  
      var value = (arguments.length <= 1 ? 0 : arguments.length - 1) ? arguments.length <= 1 ? undefined : arguments[1] : db.getState
  ();
  
      var w = db.storage.write(dest, db.getState(), format.serialize);
      return isPromise(w) ? w.then(function () {
        return value;
      }) : value;
    };
  
    db.plant = function (state) {
      db[key] = state;
      return db;
    };
  
    db.getState = function () {
      return db[key];
    };
  
    db.setState = function (state) {
      db.plant(state);
      return db.write();
    };
  
    return db.read();
  }

• example usage

  ...
        set(db.getState(), path, result);
        return db.write(source, result);
      };
  
      return getValue;
    }
  
    return common.init(db, '__state__', source, opts);
  };
  ...

module lowdb.file_async

function lowdb.file_async.read (source)

• description and source-code

  function fileSyncRead(source) {
    var deserialize = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : JSON.parse;
  
    if (fs.existsSync(source)) {
      // Read database
      var data = fs.readFileSync(source, 'utf-8').trim() || '{}';
  
      try {
        return deserialize(data);
      } catch (e) {
        if (e instanceof SyntaxError) {
          e.message = 'Malformed JSON in file: ' + source + '\n' + e.message;
        }
        throw e;
      }
    } else {
      // Initialize empty database
      fs.writeFileSync(source, '{}');
      return {};
    }
  }

• example usage

  ...
  
  ```js
  const db = low('db.json')
  db.write()            // writes to db.json
  db.write('copy.json') // writes to copy.json
  ```
  
  __db.read([source])__
  
  Reads source using `storage.read` option. Depending on the storage, it may return a promise.
  
  ```js
  const db = low('db.json')
  db.read()            // reads db.json
  db.read('copy.json') // reads copy.json
  ...

function lowdb.file_async.write (dest, obj)

• description and source-code

  function fileAsyncWrite(dest, obj) {
    var serialize = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : stringify;
  
    return new Promise(function (resolve, reject) {
      var data = serialize(obj);
  
      steno.writeFile(dest, data, function (err) {
        if (err) return reject(err);
        resolve();
      });
    });
  }

• example usage

  ...
  > A small local database powered by lodash API
  
  ```js
  const db = low('db.json')
  
  // Set some defaults if your JSON file is empty
  db.defaults({ posts: [], user: {} })
    .write()
  
  // Add a post
  db.get('posts')
    .push({ id: 1, title: 'lowdb is awesome'})
    .write()
  
  // Set a user
  ...

module lowdb.file_sync

function lowdb.file_sync.read (source)

• description and source-code

  function fileSyncRead(source) {
    var deserialize = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : JSON.parse;
  
    if (fs.existsSync(source)) {
      // Read database
      var data = fs.readFileSync(source, 'utf-8').trim() || '{}';
  
      try {
        return deserialize(data);
      } catch (e) {
        if (e instanceof SyntaxError) {
          e.message = 'Malformed JSON in file: ' + source + '\n' + e.message;
        }
        throw e;
      }
    } else {
      // Initialize empty database
      fs.writeFileSync(source, '{}');
      return {};
    }
  }

• example usage

  ...
  
  ```js
  const db = low('db.json')
  db.write()            // writes to db.json
  db.write('copy.json') // writes to copy.json
  ```
  
  __db.read([source])__
  
  Reads source using `storage.read` option. Depending on the storage, it may return a promise.
  
  ```js
  const db = low('db.json')
  db.read()            // reads db.json
  db.read('copy.json') // reads copy.json
  ...

function lowdb.file_sync.write (dest, obj)

• description and source-code

  function fileSyncWrite(dest, obj) {
    var serialize = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : stringify;
  
    var data = serialize(obj);
    fs.writeFileSync(dest, data);
  }

• example usage

  ...
  > A small local database powered by lodash API
  
  ```js
  const db = low('db.json')
  
  // Set some defaults if your JSON file is empty
  db.defaults({ posts: [], user: {} })
    .write()
  
  // Add a post
  db.get('posts')
    .push({ id: 1, title: 'lowdb is awesome'})
    .write()
  
  // Set a user
  ...

module lowdb.memory

function lowdb.memory.read ()

• description and source-code

  function memoryRead() {
    return {};
  }

• example usage

  ...
  
  ```js
  const db = low('db.json')
  db.write()            // writes to db.json
  db.write('copy.json') // writes to copy.json
  ```
  
  __db.read([source])__
  
  Reads source using `storage.read` option. Depending on the storage, it may return a promise.
  
  ```js
  const db = low('db.json')
  db.read()            // reads db.json
  db.read('copy.json') // reads copy.json
  ...

function lowdb.memory.write ()

• description and source-code

  function memoryWrite() {
    return {};
  }

• example usage

  ...
  > A small local database powered by lodash API
  
  ```js
  const db = low('db.json')
  
  // Set some defaults if your JSON file is empty
  db.defaults({ posts: [], user: {} })
    .write()
  
  // Add a post
  db.get('posts')
    .push({ id: 1, title: 'lowdb is awesome'})
    .write()
  
  // Set a user
  ...