Skip to content

Commit

Permalink
added close function readme
Browse files Browse the repository at this point in the history
  • Loading branch information
younggi committed Jan 28, 2014
1 parent 4b1b00e commit f2b6918
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ if you are only interested in a limited number of records).

This function is blocking and runs at ~4 Mhz.

### dirty.close()

Close the dirty db file handle.

### dirty event: 'load' (length)

Emitted once the database file has finished loading. It is not safe to access
Expand All @@ -107,6 +111,14 @@ key once, even if it had been overwritten.

Emitted whenever all records have been written to disk.

### dirty event: 'read_close' ()

Emitted once the database file read stream closed.

### dirty event : 'write_close' ()

Emitted once the database file write stream closed.

## Tests

[![Build Status](https://travis-ci.org/felixge/node-dirty.png)](https://travis-ci.org/felixge/node-dirty)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "dirty",
"description": "A tiny & fast key value store with append-only disk log. Ideal for apps with < 1 million records.",
"version": "0.9.8-pre",
"version": "0.9.8",
"dependencies": {},
"main": "./lib/dirty",
"devDependencies": {
Expand Down

0 comments on commit f2b6918

Please sign in to comment.