npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-module-type

v1.0.2

Published

Detect the module type of a running Node.js file.

Downloads

6

Readme

node-module-type

CI codecov NPM version

Detects if a Node.js file is executed as an ES module or CommonJS.

Requirements

  • Node.js >= 20.11.0

Example

If the project has:

  • package.json with "type": "module"
  • Uses file extensions of .mjs
  • Started node with --experimental-default-type=module

Then:

import { moduleType } from 'node-module-type'

console.log(moduleType()) // 'module'

If the project instead has:

  • package.json with "type": "commonjs" (or omitted)
  • Uses file extensions of .cjs
  • Started node with --experimental-default-type=commonjs

Then:

const { moduleType } = require('node-module-type')

console.log(moduleType()) // 'commonjs'

This is all pretty obvious based on how node-module-type was loaded by the consuming package, however, library authors publishing a dual package can provide conditional logic based on what module system your code is running under.

For example, when using TypeScript that compiles to different module systems where detection is based on the module and nearest package.json type values.

import { moduleType } from 'node-module-type'

const type = moduleType()

if (type === 'commonjs') {
  // Code running under CommonJS module scope
  import('some-cjs-dependency').then().catch()
}

if (type === 'module') {
  // Code running under ES module scope
  import('some-esm-dependency').then().catch()
}

See the tslib test for a more comprehensive example.

Output

node-module-type and the corresponding exported function moduleType produce three possible output strings:

  • unknown (only if something unexpected happens)
  • module
  • commonjs