JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 52319
  • Score
    100M100P100Q142699F
  • License MIT

Plugin for adding a `pkg` method that exposes pkg-store to your base application.

Package Exports

  • base-pkg

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (base-pkg) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

base-pkg NPM version NPM downloads Build Status

Plugin for adding a pkg method that exposes pkg-store to your base application.

Install

Install with npm:

$ npm install base-pkg --save

Usage

var pkg = require('base-pkg');
var Base = require('base');
var app = new Base();

app.use(pkg());

console.log(app.pkg.data);
//=> {"name": "my-project", ...}

API

Visit pkg-store for additional API details and documentation.

var pkg = require('base-pkg');
var Base = require('base');
var app = new Base();

.pkg.set

app.pkg.set(key, value);

Set property key with the given value.

Example

// given {"name": "my-project"}
app.pkg.set('bin.foo', 'bar');

console.log(app.pkg.data);
//=> {"name": "my-project", "bin": {"foo": "bar"}}

.pkg.save

Persist package.json to the file system at app.pkg.path.

app.pkg.save();

.pkg.get

app.pkg.get(key);

Get property key from package.json.

Example

// given {"name": "my-project"}
app.pkg.set('bin.foo', 'bar');

console.log(app.pkg.get('bin'));
//=> {"foo": "bar"}

.pkg.has

app.pkg.has(key);

Returns true if package.json has property key.

Example

// given: {"name": "my-project"}
console.log(app.pkg.has('name'));
//=> true
console.log(app.pkg.has('zzzzzzz'));
//=> false

.pkg.union

app.pkg.union(key, val);

Create array key, or concatenate values to array key. Also uniquifies the array.

Example

app.pkg.union('keywords', 'foo');
app.pkg.union('keywords', ['bar', 'baz']);

console.log(app.pkg.get('keywords'));
//=> ['foo', 'bar', 'baz']

Logging methods

A handful of logging are exposed.

.pkg.logValue

Log a value.

app.pkg.logValue('current value is:', {reflinks: ['foo', 'bar']});

Example

logValue example

.pkg.logInfo

Log an info message.

app.pkg.logInfo('udpated value:', {reflinks: ['foo', 'bar']});

Example

logInfo example

.pkg.logWarning

Log an warning message.

app.pkg.logWarning('deleted value:', {reflinks: ['foo', 'bar']});

Example

logWarning example

.pkg.logSuccess

Log a success message.

app.pkg.logSuccess('added value:', {reflinks: ['foo', 'bar']});

Example

logSuccess example

.pkg.logError

Log an error message.

app.pkg.logError('missing value:', {reflinks: ['foo', 'bar']});

Example

logError example

You might also be interested in these projects:

  • base-options: Adds a few options methods to base-methods, like option, enable and disable. See the readme… more | homepage
  • base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
  • cache-base: Basic object cache with get, set, del, and has methods for node.js/javascript projects. | homepage
  • pkg-store: Use package.json as a config store. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on April 17, 2016.