alexkwolfe

json-fs-store

  "description": "File system storage and retrieval of objects as JSON",

  "repository": "alexkwolfe/json-fs-store"

This Node.js npm module simply serializes JavaScript objects to JSON files into the file system directory of your choosing.

[![Build Status](https://travis-ci.org/alexkwolfe/json-fs-store.svg?branch=master)](https://travis-ci.org/alexkwolfe/json-fs-store)

[![Dependencies](https://david-dm.org/alexkwolfe/json-fs-store.svg?branch=master)](https://david-dm.org/alexkwolfe/json-fs-store)

The store module is a function that takes a single parameter: the path to the location on the file system where you want to store your objects. If you omit the storage location the 'store' directory in your current working directory will be used.

var store = require('json-fs-store')('/path/to/storage/location');

A stored object must have an `id` attribute (one will be provided if it does not). The object

will be serialized to JSON using `JSON.stringify` and written to the storage location. 

To customize the JSON, you can define the `#toJSON` function on the object to be stored. That function

  // called when the file has been written

  // to the /path/to/storeage/location/12345.json

  // to the /path/to/storage/location/12345.json

  if (err) throw err; // err if the save failed

To retrieve an object, you must know its `id` attribute and use it as a parameter for the `load` function.

To retrieve an object, you must know its `id` attribute and use it as a parameter for the `load()` function.

store.load('12345', function(err, loaded_donkey){

store.load('12345', function(err, object){

  if(err) throw err; // err if JSON parsing failed

  // do something with loaded_donkey here

Every call to the `#list` function reads the file system and returns the objects stored in the directory you specified when you created your store.

Every call to the `list()` function reads the file system and returns the objects stored in the directory you specified when you created your store.

Objects will be sorted according to their `name` attribute, if defined.

  // err if there was trouble reading the file system

  // objects is an array of JS objects sorted by name, one per JSON file

A stored object may be removed simply by passing the object to the `#remove` function.

A stored object may be removed simply by passing the object to the `remove()` function.

The object's `id` attribute will be used to remove the object's file from the file system.

  // called after the file has been removed

  if (err) throw err; // err if the file removal failed

		{
		"name": "json-fs-store",
		"description": "File system storage and retrieval of objects as JSON",
		"version": "0.0.3",
		"version": "0.0.4",
		"dependencies": {
		@@ -6,0 +6,0 @@ "async": "^1.4.2",

		@@ -6,2 +6,8 @@ This Node.js npm module simply serializes JavaScript objects to JSON files into the file system directory of your choosing.

		### Installing

		```
		npm install json-fs-store
		```

		### Creating a store
		@@ -32,3 +38,3 @@
		// called when the file has been written
		// to the /path/to/storeage/location/12345.json
		// to the /path/to/storage/location/12345.json
		if (err) throw err; // err if the save failed
		@@ -40,9 +46,9 @@ });

		To retrieve an object, you must know its `id` attribute and use it as a parameter for the `load` function.
		To retrieve an object, you must know its `id` attribute and use it as a parameter for the `load()` function.

		```javascript
		store.load('12345', function(err, loaded_donkey){
		store.load('12345', function(err, object){
		if(err) throw err; // err if JSON parsing failed

		// do something with loaded_donkey here
		// do something with object here

		@@ -54,3 +60,3 @@ });

		Every call to the `#list` function reads the file system and returns the objects stored in the directory you specified when you created your store.
		Every call to the `list()` function reads the file system and returns the objects stored in the directory you specified when you created your store.
		Objects will be sorted according to their `name` attribute, if defined.
		@@ -69,3 +75,3 @@

		A stored object may be removed simply by passing the object to the `#remove` function.
		A stored object may be removed simply by passing the object to the `remove()` function.
		The object's `id` attribute will be used to remove the object's file from the file system.
		@@ -72,0 +78,0 @@

Improved metrics