Skip to content

Commit b235a3d

Browse files
committed
Fix typings for snapshots
Follow-up for 61f15ae. Category: fix
1 parent 1f1c5b1 commit b235a3d

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

index.d.ts

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,27 @@
77
export function supports (...manifests: Array<Partial<IManifest>>): IManifest
88

99
/**
10-
* Describes the abilities of an
10+
* Describes the capabilities of an
1111
* [`abstract-level`](https://github.com/Level/abstract-level) database. Support matrices
1212
* for known `abstract-level` implementations can be found in
1313
* [`level-supports`](https://github.com/Level/supports#features).
1414
*/
1515
export interface IManifest {
1616
/**
17-
* Does the database have snapshot guarantees? Meaning that reads are unaffected by
18-
* simultaneous writes. For example, an iterator should read from a snapshot of the
19-
* database, created at the time `db.iterator()` was called. This means the iterator
20-
* will not see the data of simultaneous write operations.
17+
* Does the database read from a snapshot as described in
18+
* [`abstract-level`](https://github.com/Level/abstract-level#reading-from-snapshots)?
19+
*/
20+
implicitSnapshots: boolean
21+
22+
/**
23+
* Does the database implement `db.snapshot()` and do read methods accept a `snapshot`
24+
* option as described in
25+
* [`abstract-level`](https://github.com/Level/abstract-level#reading-from-snapshots)?
26+
*/
27+
explicitSnapshots: boolean
28+
29+
/**
30+
* Alias of {@link implicitSnapshots} for backwards compatibility.
2131
*/
2232
snapshots: boolean
2333

0 commit comments

Comments
 (0)