Pass parameter to npm run "my command" and use that parameter in my functions

Question

Consider app.js

const { doCoolStuff } = require("./api/myApi");
// grab param from command line into "myParam"


doCoolStuff(myParam);

... // more code

And Package.json:

{
  "name": "-------",
  "version": "1.0.0",
  "description": "",
  "main": "app.js",
  "scripts": {
    "send": "node app.js"
  },
  
  ... 
}

How can we pass parameter to app.js when running npm run send ?

Something like npm run send myEmail@myDomain.com

https://stackoverflow.com/questions/11580961/sending-command-line-arguments-to-npm-script I think your question is answered here! — Sanmitra Nagaraj, Feb 22 '21 at 10:30

score 3 · Answer 1 · answered Feb 22 '21 at 10:44

Npm will parse any argument you pass to the script unless it's passed after -- followed by a space. After npm parses them, they'll be available under npm_config_ in the environment variables.

{
      "scripts": {
        "send": "echo \"send email to $npm_config_name @ $npm_config_mail "
      }
    }

Then run

npm run demo --mail=xyz.com --name=sample

output: send email to sample@xyz.com

score 2 · Accepted Answer · answered Feb 22 '21 at 10:37

2

const params = process.argv.slice(2)

Now this param variable has all the parameters passed with the npm run command.

npm run send myEmail@domain.com

params[0] // this will provide you with the value myEmail@domain.com

answered Feb 22 '21 at 10:37

Tauseef Ahmad

76
9

score 0 · Answer 3 · answered Feb 22 '21 at 10:28

0

Use process.argv to access the arguments in your script.

As for how to specify your arguments, see: Sending command line arguments to npm script

answered Feb 22 '21 at 10:28

Halcyon

56,029
10
87
125

Pass parameter to npm run "my command" and use that parameter in my functions

3 Answers3