Socket
Socket
Sign inDemoInstall

module-definition

Package Overview
Dependencies
3
Maintainers
3
Versions
30
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    module-definition

Determines if a file is using a CommonJS or AMD module definition


Version published
Weekly downloads
1.1M
decreased by-9.98%
Maintainers
3
Install size
1.82 MB
Created
Weekly downloads
 

Readme

Source

module-definition

CI npm version npm downloads

Determines the module definition type (CommonJS, AMD, ES6, or none) for a given JavaScript file by walking through the AST.

npm install module-definition

Usage

const getModuleType = require('module-definition');

// Async
getModuleType('myscript.js', (error, type) => {
  console.log(type);
});

// Sync
let type = getModuleType.sync('myscript.js');
console.log(type);

// From source (string or an AST)
type = getModuleType.fromSource('define({foo: "foo"});');
console.log(type);

Passes one of the following strings to the given callback or returns the string in sync API:

  • amd
  • commonjs
  • es6
  • none

You may also pass an AST to fromSource to avoid an internal parsing of the source.

When specifying a filename, using the sync or async API, you can also provide an options object with an alternative fs implementation used to read the source file with.

const myFs = GetFs();
const options = { fileSystem: myFs };

// Async
getModuleType('myscript.js', (error, type) => {
  console.log(type);
}, options);

// Sync
const type = getModuleType.sync('myscript.js', options);

CLI

Assumes a global install module-definition with npm install -g module-definition

module-definition filename

License

MIT

FAQs

Last updated on 10 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc