Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

Commit 4535cf0

Browse files
committed
Merge pull request #2 from Level/add/api-docs
add api docs
2 parents c771834 + c583f24 commit 4535cf0

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,41 @@ levelup('./db', { createIfMissing: false }, function (err, db) {
2020
})
2121
```
2222

23+
## API
24+
25+
### .LevelUPError()
26+
27+
Generic error base class.
28+
29+
### .InitializationError()
30+
31+
Error initializing the database, like when the database's location argument is missing.
32+
33+
### .OpenError()
34+
35+
Error opening the database.
36+
37+
### .ReadError()
38+
39+
Error reading from the database.
40+
41+
### .WriteError()
42+
43+
Error writing to the database.
44+
45+
### .NotFoundError()
46+
47+
Data not found error.
48+
49+
Has extra properties:
50+
51+
- `notFound`: `true`
52+
- `status`: 404
53+
54+
### .EncodingError()
55+
56+
Error encoding data.
57+
2358
## Publishers
2459

2560
* [@ralphtheninja](https://github.com/ralphtheninja)

0 commit comments

Comments
 (0)