从 npm 包运行脚本

Question

Say I have a function like so

index.js

sayHi = () => {
  console.log('hi');
}

sayHi();

and I want this to run immediately when the page loads so I call it with sayHi(); now obviously this works when I have the file imported in my index.html

index.html

<! -- ... -->
<script src="./index.js"></script>

now I want to create this as a package other people can use so I have published it to npm and I can now install it using

npm install say-hi

How does sayHi() run from the users side?

I'm not exactly sure how to put this but basically once the user has installed the package using npm, I would like the script to run automatically. Is this possible?

Now I am aware that I could export the sayHi function and the user could import it and call it, I'm just wondering if this is the only way?

Answer 1

You can add lifecycle handler scripts to package.json. install or postinstall look like good candidates for your scenario

{
"scripts" :
  { "install" : "scripts/install.js"
  , "postinstall" : "scripts/install.js"
  }
}

More info at https://docs.npmjs.com/misc/scripts

Answer 2

now my question is how does sayHi() run from the users side?? I'm not exactly sure how to put this but basically once the user has installed the package using npm, I would like the script to run automatically.. is this possible?

If you publish your code as a package as you said, for users, a general usage or practise of your package is they import or require your package like require('say-hi') , at this moment ( require ), from your code, your sayHi() can be called immediately and you can see 'hi' in the console.

BTW, you do not really need to export anything if you do not want.