kanel-knex
TypeScript icon, indicating that this package has built-in type declarations

2.3.4 • Public • Published

Knex extension for Kanel

This packages extends Kanel with some Knex specific features.

Assuming you already have Kanel installed, add this with

$ npm i -D kanel-knex

knex-tables

Knex supports "implicit" type detection with a declared knex/types/tables module. This package can generate that for you. It's a pre-render hook called generateKnexTablesModule.

It will create a file in your output folder called knex-tables.ts which will cover this.

To use it, add it to your .kanelrc.js file:

const { generateKnexTablesModule } = require("kanel-knex");

module.exports = {
  // ... your config here.

  preRenderHooks: [generateKnexTablesModule],
};

Type Filter

If you are using Knex for migrations, you will have two tables in your database called knex_migrations and knex_migrations_lock, which you probably don't care about and don't want types for. The knexTypeFilter will remove those for you.

To use it, add it to your .kanelrc.js file:

const { knexTypeFilter } = require("kanel-knex");

module.exports = {
  // ... your config here.

  typeFilter: knexTypeFilter,
};

Note that type filters are simple predicates. If you have multiple, they can easily be combined with a function like this:

const combineFilters =
  (...filters) =>
  (t) =>
    filters.every((f) => f(t));

You can then use this:

module.exports = {
  // ... your config here.

  typeFilter: combineFilters(knexTypeFilter, someOtherFilter /* ... */),
};

Migration Check

However, you might want to check that your code is in sync with the database in terms of migrations, so that the types that your code was compiled with match what the database looks like.

The generateMigrationCheck pre-render hook will create a file for you that contains a function called validateMigration. This function will check the live database for the knex_migration table and check if it matches what was there when the code was generated.

To use it, add it to your .kanelrc.js file:

const { generateMigrationCheck } = require("kanel-knex");

module.exports = {
  // ... your config here.

  preRenderHooks: [generateMigrationCheck],
};

Package Sidebar

Install

npm i kanel-knex

Weekly Downloads

1,375

Version

2.3.4

License

MIT

Unpacked Size

26.7 kB

Total Files

20

Last publish

Collaborators

  • kristiandupont