Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prantlf/js-main
Checks if the current module is the main executed module. Works with Bun, Deno and Node.js.
https://github.com/prantlf/js-main
bun deno executable main node-js nodejs
Last synced: 10 days ago
JSON representation
Checks if the current module is the main executed module. Works with Bun, Deno and Node.js.
- Host: GitHub
- URL: https://github.com/prantlf/js-main
- Owner: prantlf
- License: mit
- Created: 2024-11-10T13:48:38.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-10T14:29:38.000Z (2 months ago)
- Last Synced: 2024-11-10T14:35:10.078Z (2 months ago)
- Topics: bun, deno, executable, main, node-js, nodejs
- Language: JavaScript
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
## js-main
Checks if the current module is the main executed module.
* Supports both ES and CJS modules.
* Works with Bun, Deno and Node.js.
* Includes TypeScript types.
* Zero dependencies.
* As efficient as possible depending on the completeness of `import.meta`.
* Tiny size - 503 B original, 295 B minified, 216 B gzipped, 193 B brotlied.
Node.js version 14 and newer is supported.
## Synopsis
### ES
```js
import { isMain } from 'js-main'
if (isMain(import.meta)) {
// this module has been executed
}
```
### CJS
```js
const { isMain } = require('js-main')
if (isMain(module)) {
// this module has been executed
}
```
## Installation
You can install this package using your favourite package manager:
```sh
npm i -D js-main
yarn add -D js-main
pnpm i -D js-main
bun i -D js-main
```
## API
This package exports one named function:
```ts
function isMain(import.meta | module): boolean
```
It expects the expression `import.meta` as the first parameter in an ES module and `module` in a CJS module. It returns a boolean, which will be `true` if the current module is the main executed module.
### Importing
ES or CJS export will be chosen according to the `type` from `package.json` of the importing package. The ES export type can be enforced by the path suffix `/es`:
```js
import { isMain } from 'js-main'
import { isMain } from 'js-main/es'
```
The CJS export type can be enforced by the path suffix `/cjs`:
```js
const { isMain } = require('js-main')
const { isMain } = require('js-main/cjs')
```
## About CJS
If you use only CJS modules, you can use the following code without depending on this or any other package:
```js
if (require.main === module) {
// this module has been executed
}
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code:
git clone https://github.com/prantlf/js-main.git
bun i --frozen-lockfile
bun run lint
bun run test
## License
Copyright (c) 2024 Ferdinand Prantl
Licensed under the MIT license.