Skip to content

Commit

Permalink
Merge pull request #119 from oliver-oloughlin/patch/readme-update
Browse files Browse the repository at this point in the history
chore: updated readme
  • Loading branch information
oliver-oloughlin authored Nov 21, 2023
2 parents 1984a04 + 176cf20 commit c76c4cc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

`kvdex` is a high-level abstraction layer for Deno KV with zero third-party
dependencies. It's purpose is to enhance the experience of using Deno's KV store
through additional features such as indexing, strongly typed collections, and
through additional features such as indexing, strongly typed collections and
serialization/compression, while maintaining as much of the native functionality
as possible, like atomic operations and queue listeners.

## Highlights

- CRUD operations for selected and ranged documents with strong typing.
- Primary (unique) and secondary (non-unique) indexing.
- Extensible model strategy (Zod supported)
- Extensible model strategy (Zod supported).
- Serialized, compressed and segmented storage for large objects that exceed the
native size limit.
- Support for pagination and filtering.
Expand Down Expand Up @@ -81,9 +81,9 @@ Collections are typed using models. Standard models can be defined using the
`model()` function. Alternatively, any object that implements the Model type can
be used as a model. Zod is therefore compatible, without being a dependency (see
[zodModel()](#zodmodel) for additional support). The standard model uses type
casting only, and does not validate any data when parsing. Assymetric models can
casting only, and does not validate any data when parsing. Asymmetric models can
be created by passing a transform function which maps from an input type to an
output type. Assymetric models are useful for storing derived values or filling
output type. Asymmetric models are useful for storing derived values or filling
default values. It is up to the developer to choose the strategy that fits their
use case the best.

Expand Down

0 comments on commit c76c4cc

Please sign in to comment.