uniku 0.4.2 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
[](https://jkomyno.github.io/uniku/)
|
|
7
7
|
[](https://opensource.org/licenses/MIT)
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Ten ID strategies behind one consistent, type-safe API. The fastest implementation of each in our [current CI benchmark](https://jkomyno.github.io/uniku/docs/guides/performance/).
|
|
10
10
|
|
|
11
|
-
> **uniku** */uˈniːku
|
|
11
|
+
> **uniku** */uˈniːku/*: Maltese for "unique"
|
|
12
12
|
|
|
13
13
|
[Documentation](https://jkomyno.github.io/uniku/) · [Getting started](https://jkomyno.github.io/uniku/docs/getting-started/) · [Choosing an ID](https://jkomyno.github.io/uniku/docs/guides/choosing-an-id/) · [API reference](https://jkomyno.github.io/uniku/docs/reference/entry-points/) · [CLI](https://jkomyno.github.io/uniku/docs/cli/)
|
|
14
14
|
|
|
@@ -21,11 +21,12 @@ const id = uuidv7()
|
|
|
21
21
|
|
|
22
22
|
## Why `uniku`?
|
|
23
23
|
|
|
24
|
-
- **
|
|
25
|
-
- **
|
|
26
|
-
- **
|
|
27
|
-
- **
|
|
28
|
-
- **
|
|
24
|
+
- **Fastest across the benchmark suite.** Every strategy beats its dedicated npm alternative in the current isolated-process CI benchmark, from 1.2× for UUID v4 and ObjectID to 116× for ULID.
|
|
25
|
+
- **Ten strategies, one type-safe API.** UUID v4/v7, ULID, TypeID, CUID v2, Nanoid, KSUID, ObjectID, XID, and TSID each expose a callable generator with matching typed helpers.
|
|
26
|
+
- **Portable by default.** Runs on Node.js, Bun, Deno, browsers, edge runtimes, and Cloudflare Workers using `globalThis.crypto`.
|
|
27
|
+
- **Tree-shakeable entry points.** Import only the generator you use; the package root is intentionally not exported.
|
|
28
|
+
- **Useful at system boundaries.** Validate unknown input, convert canonical binary formats to bytes, or write directly into a caller-owned buffer.
|
|
29
|
+
- **Small dependency surface.** CUID v2 is the only generator with a runtime dependency (`@noble/hashes`).
|
|
29
30
|
|
|
30
31
|
## Install
|
|
31
32
|
|
|
@@ -82,11 +83,11 @@ The [choosing guide](https://jkomyno.github.io/uniku/docs/guides/choosing-an-id/
|
|
|
82
83
|
|
|
83
84
|
## Documentation
|
|
84
85
|
|
|
85
|
-
- [Getting started](https://jkomyno.github.io/uniku/docs/getting-started/)
|
|
86
|
-
- [Generator reference](https://jkomyno.github.io/uniku/docs/reference/entry-points/)
|
|
87
|
-
- [Migration guide](https://jkomyno.github.io/uniku/docs/migration/from-other-libraries/)
|
|
88
|
-
- [Performance and bundle size](https://jkomyno.github.io/uniku/docs/guides/performance/)
|
|
89
|
-
- [Stability contract](https://github.com/jkomyno/uniku/blob/main/docs/STABILITY.md)
|
|
86
|
+
- [Getting started](https://jkomyno.github.io/uniku/docs/getting-started/): installation, direct imports, validation, and byte helpers
|
|
87
|
+
- [Generator reference](https://jkomyno.github.io/uniku/docs/reference/entry-points/): generated from the public TypeScript signatures and JSDoc
|
|
88
|
+
- [Migration guide](https://jkomyno.github.io/uniku/docs/migration/from-other-libraries/): move from `uuid`, `nanoid`, `ulid`, CUID2, KSUID, BSON, TSID, or XID libraries
|
|
89
|
+
- [Performance and bundle size](https://jkomyno.github.io/uniku/docs/guides/performance/): benchmark methodology, current measurements, and reproduction commands
|
|
90
|
+
- [Stability contract](https://github.com/jkomyno/uniku/blob/main/docs/STABILITY.md): the entry points and compatibility policy planned for `uniku@1.0.0`
|
|
90
91
|
|
|
91
92
|
## CLI companion
|
|
92
93
|
|