fsos
Release 1.1.6

A file system object storage.

Homepage Repository npm JavaScript Download

Keywords: file, object storage
License: MIT
Install: npm install fsos@1.1.6

Documentation

                                  ┌──────────┒
                                  │   fsos   ┃
                                  ┕━━━━┯━━━━━┛
                                       │
                        ╭──────────────┴───────────────╮
                        │ A file system object storage │
                        ╰──────────────────────────────╯

File system IO can be hard to get right. This library offers a simpler interface
to common operations expected from an object storage. It stays as close to the
file system as humanly possible.

    var fsos = require('fsos')
    var user = { nick: 'jade', firstName: 'Jackie', lastName: 'Dent'}
    fsos.set('user/' + user.nick, JSON.stringify(user)).then(function() {
      return fsos.get('user/' + user.nick)
    }).then(function(value) {
      console.log(value)
    })

If an object is set successfully, all subsequent gets will return the value that
was set until the object is reset.

If an object is set non-successfully, all subsequent gets will return the value
it had prior, if any, until the object is reset.

It should stay consistent even if the application crashes or if multiple
processes write to the same files. If the system crashes, it is likely to stay
consistent, but that depends on the file system.

# API

set(key, value) → Promise

Sets the value at that key. It is stored directly on a file (treating the key as
a path, automatically creating folders as needed).
The value can be a Buffer, a String, or a JSON-serializable object.
Folders (eg. `foo` if something was set to `foo/bar`) cannot contain data.

get(key) → Promise<Buffer>

Reads the value at that key. Yields an error if the key does not exist.

delete(key) → Promise

Ensures that a subsequent get yields an error.

# Notes

exists (to get a boolean describing whether there is data at a key) is left out.
Indeed, that information does not guarantee that there will be data at that key
for your next operation, as other processes may have modified it.

Dependencies: 2
Dependent packages: 8
Dependent repositories: 53
Total releases: 12
Latest release: Jun 9, 2019
First release: Jan 24, 2016
Stars: 2
Forks: 4
Watchers: 1
Contributors: 4
Repository size: 18.6 KB
SourceRank: 12