Skip to content

Commit 3b6b003

Browse files
committed
Remove codecs from supported interfaces
Closes #1.
1 parent 21f22ca commit 3b6b003

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# level-transcoder
22

3-
**Encode data with built-in or custom encodings.** The successor to [`level-codec`][level-codec] that transcodes encodings from and to internal data formats supported by a database. This allows a database to store data in a format of its choice (Buffer, Uint8Array or String) with zero-effort support of known encodings. That includes other encoding interfaces in the ecosystem like [`codecs`][mafintosh-codecs], [`abstract-encoding`][abstract-enc] and [`multiformats`][blockcodec].
3+
**Encode data with built-in or custom encodings.** The successor to [`level-codec`][level-codec] that transcodes encodings from and to internal data formats supported by a database. This allows a database to store data in a format of its choice (Buffer, Uint8Array or String) with zero-effort support of known encodings. That includes other encoding interfaces in the ecosystem like [`abstract-encoding`][abstract-enc] and [`multiformats`][blockcodec].
44

55
[![level badge][level-badge]](https://github.com/Level/awesome)
66
[![npm](https://img.shields.io/npm/v/level-transcoder.svg)](https://www.npmjs.com/package/level-transcoder)
@@ -101,10 +101,8 @@ Various modules in the ecosystem, in and outside of Level, can be used with `lev
101101
| [`charwise`][charwise] | `utf8` | [`level-codec`][level-codec] ||
102102
| [`bytewise`][bytewise] | `buffer` | [`level-codec`][level-codec] ||
103103
| [`lexicographic-integer-encoding`][lexint] | `buffer`, `utf8` | [`level-codec`][level-codec] ||
104-
| [`codecs`][mafintosh-codecs] | `buffer` | [`codecs`][mafintosh-codecs] ||
105104
| [`abstract-encoding`][abstract-enc] | `buffer` | [`abstract-encoding`][abstract-enc] ||
106105
| [`multiformats`][js-multiformats] | `view` | [`multiformats`][blockcodec] ||
107-
| [`base32-codecs`][base32-codecs] | `buffer` | [`codecs`][mafintosh-codecs] ||
108106

109107
Those marked as not named are modules that export or generate encodings that don't have a `name` property (or `type` as an alias). We call these _anonymous encodings_. They can only be used as objects and not by name. Passing an anonymous encoding through `Transcoder#encoding()` does give it a `name` property for compatibility, but the value of `name` is not deterministic.
110108

@@ -121,7 +119,7 @@ Create a new transcoder, providing the formats that are supported by a database
121119
Returns the given `encoding` argument as a normalized encoding object that follows the `level-transcoder` encoding interface. The `encoding` argument may be:
122120

123121
- A string to select a known encoding by its name
124-
- An object that follows one of the following interfaces: [`level-transcoder`](#encoding-interface), [`level-codec`](https://github.com/Level/codec#encoding-format), [`codecs`][mafintosh-codecs], [`abstract-encoding`][abstract-enc], [`multiformats`][blockcodec]
122+
- An object that follows one of the following interfaces: [`level-transcoder`](#encoding-interface), [`level-codec`](https://github.com/Level/codec#encoding-format), [`abstract-encoding`][abstract-enc], [`multiformats`][blockcodec]
125123
- A previously normalized encoding, such that `encoding(x)` equals `encoding(encoding(x))`.
126124

127125
Results are cached. If the `encoding` argument is an object and it has a name then subsequent calls can refer to that encoding by name.
@@ -209,12 +207,8 @@ Support us with a monthly donation on [Open Collective](https://opencollective.c
209207

210208
[lexint]: https://github.com/vweevers/lexicographic-integer-encoding
211209

212-
[mafintosh-codecs]: https://github.com/mafintosh/codecs
213-
214210
[abstract-enc]: https://github.com/mafintosh/abstract-encoding
215211

216212
[js-multiformats]: https://github.com/multiformats/js-multiformats
217213

218214
[blockcodec]: https://github.com/multiformats/js-multiformats/blob/master/src/codecs/interface.ts
219-
220-
[base32-codecs]: https://github.com/consento-org/base32-codecs

0 commit comments

Comments
 (0)