Skip to content

Commit 2e7c40c

Browse files
vweeversvweevers
committed
Remove old modules from support matrices
Category: none
1 parent 68bac51 commit 2e7c40c

File tree

1 file changed

+26
-96
lines changed

1 file changed

+26
-96
lines changed

‎README.md‎

Lines changed: 26 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![level badge][level-badge]](https://github.com/Level/awesome)
66
[![npm](https://img.shields.io/npm/v/level-supports.svg)](https://www.npmjs.com/package/level-supports)
77
[![Node version](https://img.shields.io/node/v/level-supports.svg)](https://www.npmjs.com/package/level-supports)
8-
[![Test](https://img.shields.io/github/actions/workflow/status/Level/supports/test.yml?branch=main&label=test)](https://github.com/Level/level/actions/workflows/test.yml)
8+
[![Test](https://img.shields.io/github/actions/workflow/status/Level/supports/test.yml?branch=main\&label=test)](https://github.com/Level/level/actions/workflows/test.yml)
99
[![Coverage](https://img.shields.io/codecov/c/github/Level/supports?label=\&logo=codecov\&logoColor=fff)](https://codecov.io/gh/Level/supports)
1010
[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript\&logoColor=fff)](https://standardjs.com)
1111
[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
@@ -75,26 +75,14 @@ Aliased as `snapshots` for backwards compatibility.
7575
<details>
7676
<summary>Support matrix</summary>
7777

78-
| Module | Implicit snapshots |
79-
| :------------------- | :---------------------------- |
80-
| `classic-level` | ✅ |
81-
| `memory-level` | ✅ |
82-
| `browser-level` | ❌ |
83-
| `rocks-level` | ✅ |
84-
| `leveldown` | ✅ |
85-
| `rocksdb` | ✅ |
86-
| `memdown` | ✅ |
87-
| `level-js` | ✅ (by buffering) |
88-
| `encoding-down` | ✅ |
89-
| `deferred-leveldown` | ✅ |
90-
| `levelup` | ✅ |
91-
| `level-packager` | ✅ |
92-
| `level` | ✅ |
93-
| `level-mem` | ✅ |
94-
| `level-rocksdb` | ✅ |
95-
| `subleveldown` | ✅ |
96-
| `multileveldown` | ✅ (unless `retry` is true) |
97-
| `level-party` | ❌ (unless `retry` is false) |
78+
| Module | Implicit snapshots |
79+
| :-------------- | :-------------------------- |
80+
| `classic-level` | ✅ |
81+
| `memory-level` | ✅ |
82+
| `browser-level` | ❌ |
83+
| `level` | ✅ |
84+
| `many-level` | ✅ (unless `retry` is true) |
85+
| `rave-level` | ❌ (unless `retry` is false) |
9886

9987
</details>
10088

@@ -105,18 +93,18 @@ Does the database implement `db.snapshot()` and do read methods accept a `snapsh
10593
<details>
10694
<summary>Support matrix</summary>
10795

108-
| Module | Explicit snapshots |
109-
| :------------------- | :-------------------------- |
110-
| `classic-level` | Not yet |
111-
| `memory-level` | Not yet |
112-
| `browser-level` | ❌ |
113-
| `rave-level` | TBD |
96+
| Module | Explicit snapshots |
97+
| :-------------- | :----------------- |
98+
| `classic-level` | Not yet |
99+
| `memory-level` | Not yet |
100+
| `browser-level` | ❌ |
101+
| `rave-level` | TBD |
114102

115103
</details>
116104

117105
### `permanence` (boolean)
118106

119-
Does data survive after process (or environment) exit? Typically true. False for [`memory-level`](https://github.com/Level/memory-level) and [`memdown`](https://github.com/Level/memdown).
107+
Does data survive after process (or environment) exit? Typically true. False for [`memory-level`](https://github.com/Level/memory-level).
120108

121109
### `seek` (boolean)
122110

@@ -125,28 +113,15 @@ Do iterators support [`seek(..)`](https://github.com/Level/abstract-level/#itera
125113
<details>
126114
<summary>Support matrix</summary>
127115

128-
| Module | Support |
129-
| :------------------- | :------ |
130-
| `abstract-level` | ✅ 1.0.0 |
131-
| `classic-level` | ✅ 1.0.0 |
132-
| `memory-level` | ✅ 1.0.0 |
133-
| `browser-level` | ✅ 1.0.0 |
134-
| `rocks-level` | ✅ 1.0.0 |
135-
| `abstract-leveldown` | ✅ 6.0.0 |
136-
| `leveldown` | ✅ 1.2.0 |
137-
| `rocksdb` | ✅ 1.0.0 |
138-
| `memdown` | ✅ 4.1.0 |
139-
| `level-js` | ❌ |
140-
| `encoding-down` | ✅ 6.1.0 |
141-
| `deferred-leveldown` | ✅ 5.1.0 |
142-
| `levelup` | ✅ n/a |
143-
| `level-packager` | ✅ n/a |
144-
| `level` | ✅ 8.0.0 |
145-
| `level-mem` | ✅ 4.0.0 |
146-
| `level-rocksdb` | ✅ 1.0.0 |
147-
| `subleveldown` | ✅ 4.1.0 |
148-
| `multileveldown` | ❌ |
149-
| `level-party` | ❌ |
116+
| Module | Support |
117+
| :--------------- | :------ |
118+
| `abstract-level` | ✅ 1.0.0 |
119+
| `classic-level` | ✅ 1.0.0 |
120+
| `memory-level` | ✅ 1.0.0 |
121+
| `browser-level` | ✅ 1.0.0 |
122+
| `level` | ✅ 8.0.0 |
123+
| `many-level` | ✅ 1.0.0 |
124+
| `rave-level` | ✅ 1.0.0 |
150125

151126
</details>
152127

@@ -171,13 +146,8 @@ Does `db.open()` support these options?
171146
| Module | Support |
172147
| :-------------- | :------ |
173148
| `classic-level` | ✅ |
174-
| `rocks-level` | ✅ |
175149
| `memory-level` | ❌ |
176150
| `browser-level` | ❌ |
177-
| `leveldown` | ✅ |
178-
| `rocksdb` | ✅ |
179-
| `memdown` | ❌ |
180-
| `level-js` | ❌ |
181151

182152
</details>
183153

@@ -193,25 +163,7 @@ if (db.supports.events.put) {
193163

194164
### `streams` (boolean)
195165

196-
Does database have the methods `createReadStream`, `createKeyStream` and `createValueStream`, following the API documented in `levelup`? For `abstract-level` databases, a standalone module called [`level-read-stream`](https://github.com/Level/read-stream) is available.
197-
198-
<details>
199-
<summary>Support matrix</summary>
200-
201-
| Module | Support |
202-
| :---------------------------------- | :------ |
203-
| `abstract-level` and dependents | ❌ |
204-
| `abstract-leveldown` and dependents | ❌ |
205-
| `levelup` | ✅ |
206-
| `level-packager` | ✅ |
207-
| `level` | ✅ |
208-
| `level-mem` | ✅ |
209-
| `level-rocksdb` | ✅ |
210-
| `subleveldown` | ✅ |
211-
| `multileveldown` | ✅ |
212-
| `level-party` | ✅ |
213-
214-
</details>
166+
Does database have the methods `createReadStream`, `createKeyStream` and `createValueStream`, following the API documented in the legacy `levelup` module? Always false since the introduction of `abstract-level` which moved streams to a standalone module called [`level-read-stream`](https://github.com/Level/read-stream).
215167

216168
### `encodings` (object)
217169

@@ -223,27 +175,6 @@ Which encodings (by name) does the database support, as indicated by nested prop
223175

224176
As the `encodings` property cannot be false (anymore, since `level-supports` v3.0.0) it implies that the database supports `keyEncoding` and `valueEncoding` options on all relevant methods, uses a default encoding of utf8 and that hence all of its read operations return strings rather than buffers by default.
225177

226-
<details>
227-
<summary>Support matrix (general support)</summary>
228-
229-
_This matrix just indicates general support of encodings as a feature, not that the listed modules support the `encodings` property exactly as described above, which only works on `abstract-level` databases._
230-
231-
| Module | Support |
232-
| :------------------------------------- | :------ |
233-
| `abstract-level` (and dependents) | ✅ |
234-
| `abstract-leveldown` (and dependents) | ❌ |
235-
| `encoding-down` | ✅ |
236-
| `levelup` | ✅ |
237-
| `level-packager` | ✅ |
238-
| `level` | ✅ |
239-
| `level-mem` | ✅ |
240-
| `level-rocksdb` | ✅ |
241-
| `subleveldown` | ✅ |
242-
| `multileveldown` | ✅ |
243-
| `level-party` | ✅ |
244-
245-
</details>
246-
247178
<details>
248179
<summary>Support matrix (specific encodings)</summary>
249180

@@ -254,7 +185,6 @@ _This matrix lists which encodings are supported as indicated by e.g. `db.suppor
254185
| `classic-level` | ✅ | ✅ | ✅ <sup>1<sup> |
255186
| `memory-level` | ✅ <sup>2<sup> | ✅ <sup>2<sup> | ✅ <sup>2<sup> |
256187
| `browser-level` | ✅ <sup>1<sup> | ✅ <sup>1<sup> | ✅ |
257-
| `rocks-level` | ✅ | ✅ | ✅ <sup>1<sup> |
258188
| `level@8` | ✅ <sup>3<sup> | ✅ <sup>3<sup> | ✅ <sup>3<sup> |
259189

260190
<small>

0 commit comments

Comments
 (0)