@kauza/knex-types
v3.0.4
Published
Generates TypeScript definitions (types) from a (PostgreSQL) database schema.
Downloads
75
Readme
Knex.js types generator
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
.
Related Projects
- GraphQL API Starter Kit — monorepo template, pre-configured with TypeScript, GraphQL.js, React, and Relay
- Node.js API Starter Kit — Node.js project template (PostgreSQL, Knex, OAuth 2.0, emails, Cloud Functions)
How to Contribute
Please create a PR or send me a message on Discord.
License
Copyright © 2021-present Kriasoft. This source code is licensed under the MIT license found in the LICENSE file.
Made with ♥ by Konstantin Tarkus (@koistya, blog) and contributors.