Node Exports Info

Common errors

• Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'node-exports-info' in ...

  cause Attempting a named import from the main package path or an incorrect subpath, but individual functions are exposed as default exports via specific subpaths.
  fix Change the import statement to target the specific subpath for the desired function using a default import, e.g., `import getCategory from 'node-exports-info/getCategory';`

• TypeError: Cannot read properties of undefined (reading 'flags') OR 'getCategoryInfo is not a function'

  cause Incorrectly importing a function or attempting to use a function that was not correctly imported as a default export from its specific subpath.
  fix Verify that the import statement correctly uses the `default` import syntax for the specific subpath of the function you intend to use. For example, `import getCategoryInfo from 'node-exports-info/getCategoryInfo';`

Warnings

• gotcha The library reflects the highly nuanced and sometimes inconsistent behavior of Node.js `exports` field across different versions. Developers should carefully interpret the category information and flags, especially when targeting older or experimental Node.js releases, as the `exports` specification evolved considerably.
  Fix: Consult the official Node.js documentation for `package.json` `exports` alongside this library's output to fully understand complex scenarios. Use the `getCategoryInfo` and `getCategoryFlags` functions to programmatically check for specific feature support.
• gotcha When importing specific utility functions, ensure you use the exact subpath import as documented (e.g., `import getCategory from 'node-exports-info/getCategory'`). Direct named imports from the main package or incorrect subpaths will result in `Module not found` or `undefined` errors.
  Fix: Always use the full subpath for each function as listed in the 'Entry points' section of the documentation. Example: `import getCategory from 'node-exports-info/getCategory';`

Install

• npm install node-exports-info npm
• yarn add node-exports-info yarn
• pnpm add node-exports-info pnpm

Imports

• getCategory
  wrong:

  import { getCategory } from 'node-exports-info'; // Incorrect: not a named export from the root package

  correct:

  import getCategory from 'node-exports-info/getCategory';

  Each utility function within `node-exports-info` is exposed as a default export from its dedicated subpath. Named imports from the root package or incorrect subpaths will not work.
• getCategoriesForRange
  wrong:

  const getCategoriesForRange = require('node-exports-info').getCategoriesForRange; // Incorrect: attempting to access as a named CommonJS export from root

  correct:

  import getCategoriesForRange from 'node-exports-info/getCategoriesForRange';

  For CommonJS environments, the correct way to import these default-exported subpath modules is `const getCategoriesForRange = require('node-exports-info/getCategoriesForRange');` directly, without destructuring.
• getCategoryInfo
  wrong:

  import { getCategoryInfo } from 'node-exports-info/getCategoryInfo'; // Incorrect: it's a default export, not a named one from the subpath

  correct:

  import getCategoryInfo from 'node-exports-info/getCategoryInfo';

  Ensure to use a default import (e.g., `import aliasName from 'module-path';`) for functions imported from their specific subpaths, rather than named destructuring imports.

Quickstart

Demonstrates how to identify the current Node.js exports category, retrieve detailed feature flags for specific categories or module systems, and list all known categories with their corresponding Node.js version ranges.

import getCategory from 'node-exports-info/getCategory';
import getCategoryInfo from 'node-exports-info/getCategoryInfo';
import getRangePairs from 'node-exports-info/getRangePairs';

// Get the exports category for the current Node.js version
const currentCategory = getCategory();
console.log(`Current Node.js exports category: ${currentCategory}`);

// Get detailed info for a specific category, e.g., 'patterns'
const patternInfo = getCategoryInfo('patterns');
console.log('\nInfo for 'patterns' category:');
console.log(JSON.stringify(patternInfo, null, 2));

// Get info for the current category, specifically for 'require' module system
const currentCategoryRequireInfo = getCategoryInfo(currentCategory, 'require');
console.log(`\nCurrent category ('${currentCategory}') flags for 'require':`);
console.log(JSON.stringify(currentCategoryRequireInfo.flags, null, 2));

// List all categories with their associated semver ranges
console.log('\nAll exports categories and their Node.js version ranges:');
getRangePairs().forEach(([range, category]) => {
  console.log(`- ${category}: ${range}`);
});