knex-types

• feat: Add support for int2 extension integer type (#26) — @cskeppstedt
• chore: Upgrade dependencies (#27) — @koistya

• feat: Generate Tables type (#14) — @d7ark

• Escape generated property names containing spaces or special characters (#11) — @bhenderson

• Add options.suffix option (#7) — @bhenderson

• Add schema and exclude options (#2) — @erlinghaugstad

updateSchema(db, {
  schema: ["public", "log"], // defaults to "public"
  exclude: ["migrate", "migrate_lock"], // defaults to []
}

Allow to add a custom prefix; improve the supported type coverage.

updateTypes({
  output: `./types.ts`,
  // Inject a custom import at the top of the generated file
  prefix: `import { PostgresInterval } from "postgres-interval";`
});

Drop generation of EntityRecord types, use Knex.DbRecord<Entity> instead.

Add citext[] db type, saving it as string[].

An utility module for Knex.js that generates TypeScript definitions (types) from a PostgreSQL database schema.

$ npm install knex
$ npm install knex-types --dev

Usage Example

const { knex } = require("knex");
const { updateTypes } = require("knex-types");

const db = knex(require("./knexfile"));

updateTypes(db, { output: "./types.ts" }).catch((err) => {
  console.error(err);
  process.exit(1);
});

Find an example of generated types in ./main.test.ts.