Skip to content

Commit

Permalink
Merge pull request #91 from powersync-ja/kysely-readme-patch
Browse files Browse the repository at this point in the history
Kysely README.md
  • Loading branch information
cahofmeyr authored Mar 6, 2024
2 parents 41dc251 + 14d79e0 commit 60f666b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/kysely-driver/README.md
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

0 comments on commit 60f666b

Please sign in to comment.