Skip to content

Commit 0837a16

Browse files
committed
Document status values
1 parent ca2a0e6 commit 0837a16

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,15 @@ See also [Level/community#79](https://github.com/Level/community/issues/79).
189189

190190
### `status` (boolean)
191191

192-
Does db have a [`status`](https://github.com/Level/abstract-leveldown/#dbstatus) property? Currently available on `abstract-leveldown` implementations, but not `levelup`.
192+
Does db have a [`status`](https://github.com/Level/abstract-leveldown/#dbstatus) property? That returns a string value that is one of:
193+
194+
- `new` - newly created, not opened or closed
195+
- `opening` - waiting for the store to be opened
196+
- `open` - successfully opened the store
197+
- `closing` - waiting for the store to be closed
198+
- `closed` - store has been successfully closed.
199+
200+
The `new` status should be avoided. It is being phased out in favor of an initial status of `closed`.
193201

194202
### `deferredOpen` (boolean)
195203

0 commit comments

Comments
 (0)