Skip to content

Commit

Permalink
Document status values
Browse files Browse the repository at this point in the history
  • Loading branch information
vweevers committed Oct 9, 2021
1 parent ca2a0e6 commit 0837a16
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,15 @@ See also [Level/community#79](https://github.com/Level/community/issues/79).

### `status` (boolean)

Does db have a [`status`](https://github.com/Level/abstract-leveldown/#dbstatus) property? Currently available on `abstract-leveldown` implementations, but not `levelup`.
Does db have a [`status`](https://github.com/Level/abstract-leveldown/#dbstatus) property? That returns a string value that is one of:

- `new` - newly created, not opened or closed
- `opening` - waiting for the store to be opened
- `open` - successfully opened the store
- `closing` - waiting for the store to be closed
- `closed` - store has been successfully closed.

The `new` status should be avoided. It is being phased out in favor of an initial status of `closed`.

### `deferredOpen` (boolean)

Expand Down

0 comments on commit 0837a16

Please sign in to comment.