Socket
Book a DemoInstallSign in
Socket

cno-package-meta

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cno-package-meta

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

0.1.0
latest
Source
npmnpm
Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

cno-package-meta

standard-readme compliant Semantic Versioning 2.0.0 Conventional Commits License ci Coverage Status npm

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

Table of Contents

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

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

Keywords

package

FAQs

Package last updated on 14 Feb 2024

Did you know?

Socket

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

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.