What is the correct way to integrate knex using inversify?

Question

What is the correct way to integrate knex using inversify?

Is there a way for me to set up knex and utilize the Inversify dependency injector to inject it wherever it is required?

typescript dependency-injection knex.js inversifyjs

Answer 1

Answer №1

Although I haven't had the opportunity to work with Knex, I am the creator of InversifyJS and I am willing to assist you.

According to the Knex documentation, you can set it up in the following manner:

var knex = require('knex')({
  client: 'mysql',
  connection: {
    host : '127.0.0.1',
    user : 'your_database_user',
    password : 'your_database_password',
    database : 'myapp_test'
  }
});

I've also located the TypeScript types for Knex here.

If you wish to inject the knex instance, you could do the following:

import * as Knex from 'knex';
import { Kernel } from "inversify";

// configuration
let configuration: Knex.Config = {
  client: 'mysql',
  connection: {
    host : '127.0.0.1',
    user : 'your_database_user',
    password : 'your_database_password',
    database : 'myapp_test'
  }
};

// instance
let knex: Knex = Knex(configuration);

let kernel = new Kernel();
kernel.bind<Knex>("Knex").toConstantValue(knex);

To make the knex a singleton, the approach above can be used. If a singleton is not desired, a factory can be implemented as follows:

 import * as Knex from 'knex';
 import { interfaces, Kernel } from "inversify";

 kernel.bind<interfaces.Factory<Knex>>("Factory<Knex>")
       .toFactory((ctx: interfaces.Context) => {
           return Knex({
               client: 'mysql',
               connection: {
                   host : '127.0.0.1',
                   user : 'your_database_user',
                   password : 'your_database_password',
                   database : 'myapp_test'
               }
           });
       });

Another option is to separate the configuration like so:

 import * as Knex from 'knex';
 import { interfaces, Kernel } from "inversify";

 kernel.bind<Knex.Config>("KnexConfig").toConstantValue({
     client: 'mysql',
     connection: {
         host : '127.0.0.1',
         user : 'your_database_user',
         password : 'your_database_password',
         database : 'myapp_test'
     }
 });

 kernel.bind<interfaces.Factory<Knex>>("Factory<Knex>")
       .toFactory((ctx: interfaces.Context) => {
           let config = context.kernel.get<Knex.Config>("KnexConfig");
           return Knex(config);
       });

These methods provide a factory for creating the knex instance:

let knexFactory = kernel.get<interfaces.Factory<Knex>>("Factory<Knex>");
let knex = knexFactory();

The factory can be injected into other classes using an @inject("Factory<Knex>") annotation.

If using a singleton or factory is not preferred, dynamic value injection can be utilized:

kernel.bind<Knex>("Knex").toDynamicValue((context: interfaces.Context) => {
    return Knex({
        client: 'mysql',
        connection: {
            host : '127.0.0.1',
            user : 'your_database_user',
            password : 'your_database_password',
            database : 'myapp_test'
        }
    });
});

This dynamic value injection approach will provide a new knex instance each time, neither a singleton nor a factory:

let knex = kernel.get<Knex>("Knex>");

Please bear in mind that these suggestions have not been tested. I hope they point you in the right direction.

Answer 2

Although I haven't had the opportunity to work with Knex, I am the creator of InversifyJS and I am willing to assist you.

According to the Knex documentation, you can set it up in the following manner:

var knex = require('knex')({
  client: 'mysql',
  connection: {
    host : '127.0.0.1',
    user : 'your_database_user',
    password : 'your_database_password',
    database : 'myapp_test'
  }
});

I've also located the TypeScript types for Knex here.

If you wish to inject the knex instance, you could do the following:

import * as Knex from 'knex';
import { Kernel } from "inversify";

// configuration
let configuration: Knex.Config = {
  client: 'mysql',
  connection: {
    host : '127.0.0.1',
    user : 'your_database_user',
    password : 'your_database_password',
    database : 'myapp_test'
  }
};

// instance
let knex: Knex = Knex(configuration);

let kernel = new Kernel();
kernel.bind<Knex>("Knex").toConstantValue(knex);

To make the knex a singleton, the approach above can be used. If a singleton is not desired, a factory can be implemented as follows:

 import * as Knex from 'knex';
 import { interfaces, Kernel } from "inversify";

 kernel.bind<interfaces.Factory<Knex>>("Factory<Knex>")
       .toFactory((ctx: interfaces.Context) => {
           return Knex({
               client: 'mysql',
               connection: {
                   host : '127.0.0.1',
                   user : 'your_database_user',
                   password : 'your_database_password',
                   database : 'myapp_test'
               }
           });
       });

Another option is to separate the configuration like so:

 import * as Knex from 'knex';
 import { interfaces, Kernel } from "inversify";

 kernel.bind<Knex.Config>("KnexConfig").toConstantValue({
     client: 'mysql',
     connection: {
         host : '127.0.0.1',
         user : 'your_database_user',
         password : 'your_database_password',
         database : 'myapp_test'
     }
 });

 kernel.bind<interfaces.Factory<Knex>>("Factory<Knex>")
       .toFactory((ctx: interfaces.Context) => {
           let config = context.kernel.get<Knex.Config>("KnexConfig");
           return Knex(config);
       });

These methods provide a factory for creating the knex instance:

let knexFactory = kernel.get<interfaces.Factory<Knex>>("Factory<Knex>");
let knex = knexFactory();

The factory can be injected into other classes using an @inject("Factory<Knex>") annotation.

If using a singleton or factory is not preferred, dynamic value injection can be utilized:

kernel.bind<Knex>("Knex").toDynamicValue((context: interfaces.Context) => {
    return Knex({
        client: 'mysql',
        connection: {
            host : '127.0.0.1',
            user : 'your_database_user',
            password : 'your_database_password',
            database : 'myapp_test'
        }
    });
});

This dynamic value injection approach will provide a new knex instance each time, neither a singleton nor a factory:

let knex = kernel.get<Knex>("Knex>");

Please bear in mind that these suggestions have not been tested. I hope they point you in the right direction.

What is the correct way to integrate knex using inversify?

Answer №1

Similar questions

Utilizing a d.ts Typescript Definition file for enhanced javascript intellisene within projects not using Typescript

Exploring the wonders of Angular 2: Leveraging NgbModal for transclusion within

Oops! Looks like there was an issue with assigning to a reference or variable: Error: Uncaught (in promise)

What are the steps for integrating Angularfire2 into an Angular application?

Exploring Ionic 4 with Angular Router

Tips for utilizing ion-img within an Ionic 3 application?

Tips for ensuring that the code inside a subscribe block completes before moving on to the next iteration within a forEach loop in Angular

An issue arises in Typescript when attempting to pass an extra prop through the server action function in the useForm

Using an array of references in React

Anticipate the desired operations and propose appropriate function identifiers within a generalized class framework

Discovering a solution to extract a value from an Array of objects without explicitly referencing the key has proven to be quite challenging, as my extensive online research has failed to yield any similar or closely related problems

The push() method replaces the last item in an array with another item

Guide to setting data types for [key, value] pairs within a forEach iteration

Is there a way to specify patternProperties in a JSON schema and then map it to a TypeScript interface?

Ways to Access HTTP Request Headers in Angular 6 upon Page Load

Issue with Angular not sending data to ASP.net server

NextJS API Generator for OpenAPI specifications

How to showcase the data retrieved via BehaviorSubject in Angular

Having trouble getting Angular 8 WebRTC to function properly on two tabs

Updating the variable in Angular 6 does not cause the view to refresh