barelyhuman/knex-types

Auto Generate Types for your database schema from your knex instance.

@barelyhuman/knex-types

Generate Model types from Knex

• @barelyhuman/knex-types
  • Schema Support
  • Usage
  • License

Schema Support

While the below checklist mentions Partial, most of what the library can generate should be usable. It says partial because things like enum and other constraints that can be used to generate better types and models for knex are still not done.

• Sqlite
• Postgres (Partial)
• MSSQL (Partial)
• Oracle (Partial)

Usage

// in CJS
const { generateTypes } = require("@barelyhuman/knex-types");
const knexInstance = knex(config);

generateTypes(knexInstance, {
  output: "./types.d.ts",
}).then((d) => {
  // Done
});

// in ESM
import { generateTypes } from "@barelyhuman/knex-types";
const knexInstance = knex(config);
await generateTypes(knexInstance, {
  output: "./types.d.ts",
});

License

MIT