In the process of developing module A, I have implemented a feature where users can choose to inject a Winston logger into my module. As a result, winston becomes a peer dependency.
However, when attempting to include module A in another module without the need for logging (therefore excluding Winston) and compiling with tsc, TypeScript raises an error:
The module 'winston' or its corresponding type declarations cannot be found.
What is the recommended solution for this issue?
Starting from NPM version 7.x, an additional configuration option called peerDependenciesMeta in the package.json file allows for a specific feature, as described in this documentation.
For instance, within the "Module A" package.json:
"peerDependencies": {
"winston": "> 1.0.0 <= 1.2.10",
"foo": "~2.3.0"
},
"peerDependenciesMeta": {
"winston": {
"optional": true
}
}
In this scenario, when adding Module A as a dependency to another project, the installation will allow for the presence of the winston dependency within the specified semver range > 1.0.0 <= 1.2.10. If the dependency is missing entirely, no errors will occur, allowing its absence.
It's important to note that based on this example, the foo dependency remains mandatory unless marked as optional.
Additionally, you can utilize a handy utility at to verify and test version ranges for available NPM packages, which I found beneficial as well.
PS. This marks my debut answer on SO! :)
A small addition to @tmilar's response would be helpful.
I have implemented a similar method for adding optional dependencies (including winston as well :))
This example is specifically for npm@7 which introduces support for peerDependenciesMeta
"peerDependencies": {
"winston": "~3.3.0"
},
"peerDependenciesMeta": {
"winston": {
"optional": true
}
}
If you are using optional dependencies, be prepared for exceptions during require and ensure that package versions are checked
let winston;
let winstonVersion;
try {
winston = require('winston')
winstonVersion = require('winston/package.json').version
} catch (er) {
winston = null
}
if (isUnsupportedVersion(winstonVersion) ) {
winston = null
}
// .. later in your code ..
if (winston) {
winston.doSomething()
}
Having trouble implementing a session timeout feature in my code. I need the timer to reset whenever a user interacts with the function. Can't figure out how to integrate similar code like the one provided as an example on Stack Overflow. This is the ...
Version: 8.1.0 The prototype I am working with is as follows: String.prototype.toSlug = function () { return (<string>this) .trim() .toLowerCase() .replace(/\s+/g, '-') .replace(/[^\w\-]+/g, '') ...
I am trying to import a js file in typescript and access objects and functions within the file. I have added the js file in index.html, but it is not working as expected. I tried using "import '[js file path]'" but it did not work. import { Comp ...
Currently in the process of converting a JavaScript code to TypeScript. Previously, I had a class that was functioning correctly in JS class Model { constructor(input, alias) { this.tableName = input; this.alias = alias; } } Howev ...
I'm feeling like I'm going crazy and could really use some assistance. My predicament involves a function that looks like this: private generateTimeObject(firstObject: someInterface, secondObject?: someInterface) { let firstTime; let secondTi ...
Lately, in my extensive react-typescript project, I have encountered a peculiar issue. It seems that syntax errors are popping up everywhere, but only within the new code that I write. For instance, when creating a new component: import React from 're ...
I have a markdown editor in View A which is displaying the result in the current View. My goal is to share this result with another page, View B. In View A, there is a button that allows the user to share the markdown result with View B. I am using a texta ...
Seeking guidance on querying CloudWatch logs across accounts using lambda and AWS SDK Developing a lambda function in typescript Deploying lambda with CloudFormation, granting necessary roles for reading from two different AWS accounts Initial exe ...
Currently, I have successfully set up a create-react-app and a storybook packages in a lerna monorepo. My goal now is to utilize the components created within the storybook package in an entirely fresh repository. I attempted using npm install git://githu ...
My main focus is on rendering Markdown. Additionally, I also need to parse HTML which is passed as a string. In this scenario, children represents the HTML passed as a string, while isParseRequired indicates if parsing is needed. import cx from 'clas ...
After creating an Angular 16.1.0 application and a custom pipe, I encountered error messages during compilation. Here are the steps I took: Ran ng new exampleProject Generated a pipe using ng generate pipe power Modified the content of app.compone ...
The authentication token for AWS Codeartifact expires every 12 hours, requiring a new token to be generated. Is there a way to automate the process of updating this token instead of having to manually run the command each time? I attempted to set the com ...
Struggling over the past couple of days to configure Typescript in a basic template-generated Nativescript-Vue project has been quite the challenge. Here's my journey: Initiated the project using this command: ERROR in Entry module not found: Erro ...
I am seeking a solution to access the "description" property of objects within an array and utilize a string cutting method, such as slice, in order to return an array of modified objects. I have attempted using for loops but have been unsuccessful. Here ...
I'm currently in the process of setting up a WebSocket.Server using ws, Express 4, NodeJS, and TypeScript by following a guide. However, I've encountered an issue with the provided code not working as expected from the tutorial found at . In ord ...
I have developed a pure Typescript class that serves as a utility class for performing a specific task. Within this class, I have created a context that is intended to be used universally. My goal is to utilize this context and its values within the pure T ...
Managing changes to properties of classes in TypeScript can be optimized by tracking only the fields that have actually changed. Instead of using an array to keep track of property changes, I am exploring the idea of implementing an isDirty check. By incor ...
Is there a simple solution to my dilemma? I'm attempting to develop a function that gathers the outcomes of multiple functions into an array. TypeScript seems to be raising objections. How can I correctly modify this function? const func = (x:number, ...
When it comes to unit tests, I prefer a more flexible approach with dynamic generic types that eliminate the need for type casting. I want T to be open-ended, but if I specify a type, I expect to receive an exact match. For R, I need it to precisely matc ...
I am trying to display the caret position of my editor on a specific place on the website. I have created a directive and service to share variables between the controller and directive. Inside the directive, I have enabled events like "keyup", "mouseup", ...