@vercel/kv2 0.0.1 → 0.0.2
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 +26 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @vercel/kv2
|
|
1
|
+
# @vercel/kv2 (Under Development)
|
|
2
2
|
|
|
3
3
|
A type-safe key-value store backed by Vercel Blob with edge caching and copy-on-write branch isolation.
|
|
4
4
|
|
|
@@ -39,33 +39,33 @@ await users.delete("alice");
|
|
|
39
39
|
|
|
40
40
|
| Feature | Description | Docs |
|
|
41
41
|
|---------|-------------|------|
|
|
42
|
-
| **Typed Stores** | Type-safe sub-stores with automatic key prefixing | [Typed Stores](docs/typed-stores.md) |
|
|
43
|
-
| **Iteration** | `entries()` and `getMany()` with bounded concurrency | [Iterating and Pagination](docs/iterating-and-pagination.md) |
|
|
44
|
-
| **Pagination** | Cursor-based pagination for HTTP APIs | [Iterating and Pagination](docs/iterating-and-pagination.md) |
|
|
45
|
-
| **Optimistic Locking** | Version-based conflict detection and retry | [Optimistic Locking](docs/optimistic-locking.md) |
|
|
46
|
-
| **Metadata** | Typed per-entry metadata, available without loading values | [Metadata](docs/metadata.md) |
|
|
47
|
-
| **Schema & Trees** | Hierarchical data with batched tree loading | [Schema and Trees](docs/schema-and-trees.md) |
|
|
48
|
-
| **Indexes** | Secondary indexes with unique constraints | [Indexes](docs/indexes.md) |
|
|
49
|
-
| **Edge Caching** | Write-through cache with tag invalidation | [Caching](docs/caching.md) |
|
|
50
|
-
| **Streaming** | Large values streamed without buffering | [Streaming](docs/streaming.md) |
|
|
51
|
-
| **Copy-on-Write** | Preview branches inherit from production | [Copy-on-Write Branches](docs/copy-on-write-branches.md) |
|
|
52
|
-
| **CLI Explorer** | Interactive KV store explorer for debugging | [CLI](docs/cli.md) |
|
|
42
|
+
| **Typed Stores** | Type-safe sub-stores with automatic key prefixing | [Typed Stores](https://github.com/vercel-labs/KV2/blob/main/docs/typed-stores.md) |
|
|
43
|
+
| **Iteration** | `entries()` and `getMany()` with bounded concurrency | [Iterating and Pagination](https://github.com/vercel-labs/KV2/blob/main/docs/iterating-and-pagination.md) |
|
|
44
|
+
| **Pagination** | Cursor-based pagination for HTTP APIs | [Iterating and Pagination](https://github.com/vercel-labs/KV2/blob/main/docs/iterating-and-pagination.md) |
|
|
45
|
+
| **Optimistic Locking** | Version-based conflict detection and retry | [Optimistic Locking](https://github.com/vercel-labs/KV2/blob/main/docs/optimistic-locking.md) |
|
|
46
|
+
| **Metadata** | Typed per-entry metadata, available without loading values | [Metadata](https://github.com/vercel-labs/KV2/blob/main/docs/metadata.md) |
|
|
47
|
+
| **Schema & Trees** | Hierarchical data with batched tree loading | [Schema and Trees](https://github.com/vercel-labs/KV2/blob/main/docs/schema-and-trees.md) |
|
|
48
|
+
| **Indexes** | Secondary indexes with unique constraints | [Indexes](https://github.com/vercel-labs/KV2/blob/main/docs/indexes.md) |
|
|
49
|
+
| **Edge Caching** | Write-through cache with tag invalidation | [Caching](https://github.com/vercel-labs/KV2/blob/main/docs/caching.md) |
|
|
50
|
+
| **Streaming** | Large values streamed without buffering | [Streaming](https://github.com/vercel-labs/KV2/blob/main/docs/streaming.md) |
|
|
51
|
+
| **Copy-on-Write** | Preview branches inherit from production | [Copy-on-Write Branches](https://github.com/vercel-labs/KV2/blob/main/docs/copy-on-write-branches.md) |
|
|
52
|
+
| **CLI Explorer** | Interactive KV store explorer for debugging | [CLI](https://github.com/vercel-labs/KV2/blob/main/docs/cli.md) |
|
|
53
53
|
|
|
54
54
|
## Documentation
|
|
55
55
|
|
|
56
|
-
1. [Getting Started](docs/getting-started.md) — installation, quick start, environment setup
|
|
57
|
-
2. [Iterating and Pagination](docs/iterating-and-pagination.md) — keys, entries, getMany, cursor pagination
|
|
58
|
-
3. [Typed Stores](docs/typed-stores.md) — getStore, key prefixing, nested stores
|
|
59
|
-
4. [Optimistic Locking](docs/optimistic-locking.md) — versions, conflict detection, retry patterns
|
|
60
|
-
5. [Metadata](docs/metadata.md) — typed metadata, filtering without loading values
|
|
61
|
-
6. [Schema and Trees](docs/schema-and-trees.md) — defineSchema, tree loading, key builders
|
|
62
|
-
7. [Indexes](docs/indexes.md) — secondary indexes, unique constraints, reindexing
|
|
63
|
-
8. [Caching](docs/caching.md) — cache hierarchy, TTL, custom cache
|
|
64
|
-
9. [Streaming](docs/streaming.md) — binary format, large values, streaming reads/writes
|
|
65
|
-
10. [Copy-on-Write Branches](docs/copy-on-write-branches.md) — branch isolation, upstream config
|
|
66
|
-
11. [Testing and Tracing](docs/testing-and-tracing.md) — FakeBlobStore, tracers, stats
|
|
67
|
-
12. [CLI](docs/cli.md) — interactive KV store explorer
|
|
68
|
-
13. [API Reference](docs/api-reference.md) — full interface and options documentation
|
|
56
|
+
1. [Getting Started](https://github.com/vercel-labs/KV2/blob/main/docs/getting-started.md) — installation, quick start, environment setup
|
|
57
|
+
2. [Iterating and Pagination](https://github.com/vercel-labs/KV2/blob/main/docs/iterating-and-pagination.md) — keys, entries, getMany, cursor pagination
|
|
58
|
+
3. [Typed Stores](https://github.com/vercel-labs/KV2/blob/main/docs/typed-stores.md) — getStore, key prefixing, nested stores
|
|
59
|
+
4. [Optimistic Locking](https://github.com/vercel-labs/KV2/blob/main/docs/optimistic-locking.md) — versions, conflict detection, retry patterns
|
|
60
|
+
5. [Metadata](https://github.com/vercel-labs/KV2/blob/main/docs/metadata.md) — typed metadata, filtering without loading values
|
|
61
|
+
6. [Schema and Trees](https://github.com/vercel-labs/KV2/blob/main/docs/schema-and-trees.md) — defineSchema, tree loading, key builders
|
|
62
|
+
7. [Indexes](https://github.com/vercel-labs/KV2/blob/main/docs/indexes.md) — secondary indexes, unique constraints, reindexing
|
|
63
|
+
8. [Caching](https://github.com/vercel-labs/KV2/blob/main/docs/caching.md) — cache hierarchy, TTL, custom cache
|
|
64
|
+
9. [Streaming](https://github.com/vercel-labs/KV2/blob/main/docs/streaming.md) — binary format, large values, streaming reads/writes
|
|
65
|
+
10. [Copy-on-Write Branches](https://github.com/vercel-labs/KV2/blob/main/docs/copy-on-write-branches.md) — branch isolation, upstream config
|
|
66
|
+
11. [Testing and Tracing](https://github.com/vercel-labs/KV2/blob/main/docs/testing-and-tracing.md) — FakeBlobStore, tracers, stats
|
|
67
|
+
12. [CLI](https://github.com/vercel-labs/KV2/blob/main/docs/cli.md) — interactive KV store explorer
|
|
68
|
+
13. [API Reference](https://github.com/vercel-labs/KV2/blob/main/docs/api-reference.md) — full interface and options documentation
|
|
69
69
|
|
|
70
70
|
## Environment Variables
|
|
71
71
|
|
|
@@ -73,7 +73,7 @@ await users.delete("alice");
|
|
|
73
73
|
BLOB_READ_WRITE_TOKEN=vercel_blob_...
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
See [Getting Started](docs/getting-started.md) for full environment setup.
|
|
76
|
+
See [Getting Started](https://github.com/vercel-labs/KV2/blob/main/docs/getting-started.md) for full environment setup.
|
|
77
77
|
|
|
78
78
|
## Testing
|
|
79
79
|
|