transferring libraries via functions in TypeScript

Question

transferring libraries via functions in TypeScript

As I work on developing my app, I have decided to implement the dependency-injection pattern. In passing mongoose and config libraries as parameters, I encountered an issue with the config library. Specifically, when hovering over config.get('dbUri'), an error message pops up saying: 'Untyped function calls may not accept type arguments.ts(2347)'

app.ts

(async () => await initializeDatabaseConnection(mongoose, config))();

connect.ts

async function initializeDatabaseConnection(mongoose: any, config: any):Promise<void>{
    try {
        const dbUri = config.get<string>('dbUri');
        
        await mongoose.connect(dbUri, () => {
            console.log('connected to the database successfully!');
        });
    } catch (error) {
        process.exit(1)
    }
}

export default initializeDatabaseConnection;

typescript function dependency-injection parameters libraries

Answer 1

Answer №1

You have entered the value config as any, and then attempted to use it as if it were a generic parameter. However, since any signifies that TypeScript does not know the type of this variable, you cannot treat it as having a generic parameter.

To quickly resolve this issue, eliminate the <string>:

const dbUri = config.get('dbUri');

Nevertheless, a strongly-typed solution would be more appropriate in this scenario.

The type for mongoose is likely the type imported from import mongoose from 'mongoose'. It appears you will need to obtain the typeof mongoose since the package may not export a specific type for this purpose.

Subsequently, you must type config based on its actual type. Assuming your config resembles something like:

class ConfigService {
  get<T>(prop: string): T {
    return someConfigObject[prop]
  }
}

And at some point during dependency injection, you instantiate an object of that class.

Following these steps, you can specify the type for connectDb as shown below:

import type mongooseGlobal from 'mongoose'

async function connectDb(
  mongoose: typeof mongooseGlobal,
  config: ConfigService
): Promise<void>{
  //...
}

The key takeaway here is that you must determine the type of the object you wish to pass as a parameter to a function. If an appropriate type already exists, utilize it. If not, utilize typeof to derive the type from a given value.

Playground

Answer 2

You have entered the value config as any, and then attempted to use it as if it were a generic parameter. However, since any signifies that TypeScript does not know the type of this variable, you cannot treat it as having a generic parameter.

To quickly resolve this issue, eliminate the <string>:

const dbUri = config.get('dbUri');

Nevertheless, a strongly-typed solution would be more appropriate in this scenario.

The type for mongoose is likely the type imported from import mongoose from 'mongoose'. It appears you will need to obtain the typeof mongoose since the package may not export a specific type for this purpose.

Subsequently, you must type config based on its actual type. Assuming your config resembles something like:

class ConfigService {
  get<T>(prop: string): T {
    return someConfigObject[prop]
  }
}

And at some point during dependency injection, you instantiate an object of that class.

Following these steps, you can specify the type for connectDb as shown below:

import type mongooseGlobal from 'mongoose'

async function connectDb(
  mongoose: typeof mongooseGlobal,
  config: ConfigService
): Promise<void>{
  //...
}

The key takeaway here is that you must determine the type of the object you wish to pass as a parameter to a function. If an appropriate type already exists, utilize it. If not, utilize typeof to derive the type from a given value.

Playground

transferring libraries via functions in TypeScript

Answer №1

Similar questions

Creating numerous bar graphs for each specific date

Creating a TypeScript class with methods to export as an object

Techniques for returning errors to the calling function using async functions

Include the providers after declaring the AppModule

Using Angular to send a text to an injection service

What is the best way to showcase a file edited in Emacs within Atom?

When is the AbortSignal in the TanStack useQuery function considered as undefined?

Exploring the concept of type inheritance in TypeScript

Exploring async componentDidMount testing using Jest and Enzyme with React

Elevate a counter value within a nested for loop in Angular framework

Implementing advanced error handling using custom error messages with enums

What is the best way to retrieve the height and width of a device's display in Angular 2 using Typescript

Despite the unconsumedBufferLength being 0, DataReader.loadAsync is still being completed

Creating a new element in the DOM when a button is clicked using Angular 2+

Angular Error: Attempting to access property 'then' of undefined object causes TypeError

When utilizing useRef and useCallback in React, the output is visible in the console log but does not appear on the page

SystemJS could not locate the root directory for RxJS

I am interested in utilizing the request-reply pattern with KafkaJS in a TypeScript environment. Could you provide guidance on how to successfully implement this?

What could be the reason for my Angular 2 app initializing twice?

How can I showcase array elements using checkboxes in an Ionic framework?