Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugojosefson/deno-kv-entity
Typed library for specifying and storing entities in a Deno.Kv database.
https://github.com/hugojosefson/deno-kv-entity
database db deno deno-kv key-value kv
Last synced: 29 days ago
JSON representation
Typed library for specifying and storing entities in a Deno.Kv database.
- Host: GitHub
- URL: https://github.com/hugojosefson/deno-kv-entity
- Owner: hugojosefson
- License: mit
- Created: 2023-05-14T21:45:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-06T13:22:05.000Z (9 months ago)
- Last Synced: 2024-04-08T16:52:11.828Z (9 months ago)
- Topics: database, db, deno, deno-kv, key-value, kv
- Language: TypeScript
- Homepage:
- Size: 91.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# kv_entity
Typed library for specifying and storing entities in a
[Deno.Kv](https://deno.com/kv) database.
[](https://deno.land/x/kv_entity)
[](https://github.com/hugojosefson/deno-kv-entity/actions/workflows/ci.yaml)
## Requirements
Requires [Deno](https://deno.land/) v1.42.1 or later, with the `--unstable-kv`
flag.
## API
Please see the
[auto-generated API documentation](https://deno.land/x/kv_entity?doc).
## Example usage
```typescript
import {
EntityDb,
EntityDefinition,
} from "https://deno.land/x/kv_entity/mod.ts";
// What your data looks like. These are yours. You define them,
// but each must have at least one unique property.
interface Person {
email: string;
name: string;
}
interface Invoice {
invoiceNumber: string;
customerEmail: string;
amount: number;
}
// Describe them to the EntityDb
const personDefinition: EntityDefinition = {
id: "person",
uniqueProperties: ["email"],
indexedPropertyChains: [],
_exampleEntityInstance: {} as Person,
};
const invoiceDefinition: EntityDefinition = {
id: "invoice",
uniqueProperties: ["invoiceNumber"],
indexedPropertyChains: [
["customerEmail"],
],
_exampleEntityInstance: {} as Invoice,
};
// Create the EntityDb, using the definitions
const db = new EntityDb({
dbFilePath: "example-person-invoice.db",
entityDefinitions: {
person: personDefinition,
invoice: invoiceDefinition,
},
});
// Use the EntityDb
const alice: Person = {
email: "[email protected]",
name: "Alice",
};
const invoice1: Invoice = {
invoiceNumber: "1",
customerEmail: "[email protected]",
amount: 100,
};
await db.save("person", alice);
await db.save("invoice", invoice1);
// Find the objects
const aliceFromDb: Person | undefined = await db.find(
"person",
"email",
"[email protected]",
);
console.log({ aliceFromDb });
const invoicesForAlice: Invoice[] | undefined = await db.findAll("invoice", [[
"customerEmail",
"[email protected]",
]]);
console.log({ invoicesForAlice });
```
You may run the above example with:
```sh
deno run --unstable-kv --reload --allow-write=example-person-invoice.db --allow-read=example-person-invoice.db https://deno.land/x/kv_entity/readme/person-invoice.ts
```
For further usage examples, see the tests:
- [test/entity-db.test.ts](test/entity-db.test.ts)