Skip to content

Commit

Permalink
chore: changeset
Browse files Browse the repository at this point in the history
  • Loading branch information
tmm committed Oct 25, 2023
1 parent 2ffd8b4 commit a995110
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/hungry-crabs-brake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"kysely-migrate": patch
---

Added codegen
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ Run `kysely-migrate --help` or `kysely-migrate <command> --help` to see the list

Creates [`Config`](#config) object.

```ts
import { defineConfig } from 'kysely-migrate'
```

| Name | Type | Description |
| ------- | ------------------------------------------ | --------------------------------------------------------------------- |
| `config` | `Config \| (() => Config \| Promise<Config>)` | Configuration object or a function that returns a configuration object. |
Expand All @@ -63,6 +67,10 @@ Creates [`Config`](#config) object.

Loads environment variables from `.env` or `.env.*` files.

```ts
import { loadEnv } from 'kysely-migrate'
```

| Name | Type | Description |
| -------------- | ------------------------- | ------------------------------------------- |
| `config.mode` | `string \| undefined` | `.env` file type (e.g. `` `.env.${mode}` ``) |
Expand All @@ -73,6 +81,10 @@ Loads environment variables from `.env` or `.env.*` files.

`Config` object.

```ts
import { type Config } from 'kysely-migrate'
```

```ts
{
/** Kysely instance used to manipulate migrations and introspect database */
Expand Down Expand Up @@ -113,6 +125,10 @@ import {
} from 'kysely-migrate'
```

## Contributing

Contributions to kysely-migrate are greatly appreciated! If you're interested in contributing, please create a [new GitHub Discussion](https://github.com/tmm/kysely-migrate/discussions/new?category=ideas) with some info on what you would like to work on **before submitting a pull request**.

## Sponsors

If you find kysely-migrate useful or use it for work, please consider supporting development on [GitHub Sponsors](https://github.com/sponsors/tmm). Thank you 🙏

0 comments on commit a995110

Please sign in to comment.