Skip to content

Kysely README.md #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cahofmeyr merged 1 commit into from
Mar 6, 2024
Merged

Kysely README.md #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/kysely-driver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `kysely-driver` package is currently in a beta release.

## Getting started

Setup the PowerSync Database and wrap it with Kysely.
Set up the PowerSync Database and wrap it with Kysely.

Table column object type definitions are not yet available in JavaScript.

Expand All @@ -33,8 +33,8 @@ export const powerSyncDb = factory.getInstance();
export const db = wrapPowerSyncWithKysely(powerSyncDb);
```

When defining the app schema with new `TableV2` declarations the TypeScript types for tables can be automatically generated.
See [example](https://github.com/powersync-ja/powersync-js/blob/main/demos/nextjs-supabase-todolist/src/library/powersync/AppSchema.ts) for defining the app schema with `TableV2`.
When defining the app schema with new `TableV2` declarations, the TypeScript types for tables can be automatically generated.
See an [example](https://github.com/powersync-ja/powersync-js/blob/main/demos/nextjs-supabase-todolist/src/library/powersync/AppSchema.ts) of defining the app schema with `TableV2`.

```TypeScript
import { wrapPowerSyncWithKysely } from '@powersync/kysely-driver';
Expand Down Expand Up @@ -63,7 +63,7 @@ export const powerSyncDb = factory.getInstance();
export const db = wrapPowerSyncWithKysely<Database>(powerSyncDb)
```

For more information on Kysely typing [here](https://kysely.dev/docs/getting-started#types).
For more information on Kysely typing, see [here](https://kysely.dev/docs/getting-started#types).

Now you are able to use Kysely queries:

Expand Down