anadian/cno-package-meta

A micropackage (formerly simple-package-meta) which offers easy access to information about the running package.

cno-package-meta

A micropackage (formerly simple-package-meta) which offers easy access to information about the running package.

Table of Contents

• Background
• Install
• Usage
• API
• Contributing
• License

Background

A simple sort of convenience, sort of learning ECMAscript module package which takes a URL or an object like from import.meta and returns an object with information about the file like its name, version, directories and the nearest package.json.

Install

Using pnpm:

pnpm add --save cno-package-meta

It can, of course, also be installed by NPM or Yarn using the normal methods.

Usage

import getPackageMeta from 'cno-package-meta'; //The default is just the getPackageMeta function
import * as PackageMetaNS from 'cno-package-meta'; //The whole namespace

var meta_info = getPackageMeta( import.meta ); //Same as PackageMetaNS.getPackageMeta

API

The package comprises a single constructor and two functions.

new PackageMeta( object ); //Can take either a URL string, a URL object or an `import.meta`-like object

This creates a new PackageMeta object albeit lacking some information which requires blocking operations; this is made available by importing the entire module namespace with the name PackageMetaNS.PackageMeta() and is intended mainly just for debugging or extending the object as generally you're better off using one of the following helper functions.

getPackageMeta( object )

The default export, this asynchronously returns a complete PackageMeta object of the structure:

{
	name: '',
	version: '',
	packageJSON: {},
	url: '',
	filename: '',
	dirname: '',
	paths: {
		packageDirectory: '',
		data: '',
		config: '',
		cache: '',
		log: '',
		temp: ''
	}
}

PackageMetaNS.getPackageMetaSync( object )

Same as above except synchronous.

Contributing

Changes are tracked in CHANGELOG.md.

License

MIT ©2022 Anadian

SEE LICENSE IN LICENSE

This project's documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.