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

list-exports

v1.1.0

Published

Given a package name and a version number, or a path to a package.json, what specifiers does it expose?

Downloads

453

Readme

list-exports Version Badge

Build Status dependency status dev dependency status License Downloads

npm badge

Given a path to a package.json, what specifiers does it expose?

The package export defaults an async function. It fulfills with an object with the following keys:

  • name the package name
  • version: the package version
  • engines: the package's engines requirements
  • binaries: the files that are made available as executable programs
  • errors: any validation errors encountered during parsing. Note that these errors do not necessarily interfere with the listed entry points being accessible at runtime.

In addition to the required package.json path, it also takes a second argument, an options object. This object supports the following properties:

  • level: must be 'all' (the default), or 'without conditions'
    • 'all' means "supports everything latest node supports", which includes export conditions. (note: subpath patterns are not yet supported)
    • 'without conditions' means "support what node v13.2 - v13.6 support", which in the "exports" field only allows the string form or an object with the "default" property set

For ESM-supporting node versions (at the time of this writing, ^12.17 || >= 13.2):

  • require: valid specifiers to pass into require
  • import: valid specifiers to pass into import(), or to use in a static import statement
  • files: all files on the filesystem that are directly exposed by the above entry points
  • tree: a hierarchical object structure where each directory is represented as a key containing an object, and each file is represented as a key containing a list of the entry points that expose that file

For node versions prior to ESM support (at the time of this writing, < 12.17 || ~13.0 || ~13.1):

  • require (pre-exports): valid specifiers to pass into require
  • files (pre-exports): all files on the filesystem that are directly exposed by the above entry points
  • tree (pre-exports): a hierarchical object structure where each directory is represented as a key containing an object, and each file is represented as a key containing a list of the entry points that expose that file

Example

expected.json:

{
	"name": "list-exports",
	"version": "1.0.0",
	"engines": {
		"node": ">= 10"
	},
	"binaries": [],
	"require": [
		"list-exports",
		"list-exports/package.json"
	],
	"import": [
		"list-exports",
		"list-exports/package.json"
	],
	"files": [
		"./index.js",
		"./index.mjs",
		"./package.json"
	],
	"tree": {
		"list-exports": {
			"index.js": [
				"list-exports"
			],
			"index.mjs": [
				"list-exports"
			],
			"package.json": [
				"list-exports/package.json"
			]
		}
	},
	"require (pre-exports)": [
		"list-exports",
		"list-exports/",
		"list-exports/index",
		"list-exports/index.js",
		"list-exports/package",
		"list-exports/package.json"
	],
	"files (pre-exports)": [
		"./index.js",
		"./index.mjs",
		"./package.json"
	],
	"tree (pre-exports)": {
		"list-exports": {
			"index.js": [
				"list-exports",
				"list-exports/",
				"list-exports/index",
				"list-exports/index.js"
			],
			"index.mjs": [
				"list-exports/index.mjs"
			],
			"package.json": [
				"list-exports/package",
				"list-exports/package.json"
			]
		}
	},
	"errors": []
}
const assert = require('assert');
const listExports = require('list-exports');
const expected = require('./expected.json');

listExports('list-exports@1').then((data) => {
	assert.deepEqual(data, expected);
}).catch((e) => {
	console.error(e);
	process.exit(1);
});