MachineRegistry.getMachinepackInfo()

Get metadata for the specified machinepack, including a list of its machines.

Usage

Hover over inputs/exits for more info.

var MachineRegistry = require('machinepack-registry');


// Get metadata for the specified machinepack, including a list of its machines.

MachineRegistry.getMachinepackInfo({

machinepack: 'machinepack-whatever',

registry: 'http://node-machine.org',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// No machinepack with specified identity found in registry.

notFound: function () {

 

},

// OK.

success: function (result) {

 

},

});

Inputs

machinepack required

The identity of the machinepack to look up.

'machinepack-whatever'
registry

The base URL of the machine registry to use (defaults to the public registry at http://node-machine.org)

'http://node-machine.org'

Exits

error

An unexpected error occurred.

notFound

No machinepack with specified identity found in registry.

success

OK.

{ npmPackageName: 'machinepack-facebook',
  identity: 'machinepack-facebook',
  friendlyName: 'Facebook',
  variableName: 'Facebook',
  description: 'asg',
  extendedDescription: 'blah blah',
  moreInfoUrl: 'http://foobar.com',
  iconSrc: 'http://foobar.com/icon.png',
  version: '0.1.1',
  keywords: [ 'machine' ],
  latestVersionPublishedAt: '2015-01-19T22:26:54.588Z',
  author: 'Marty McFly <marty@mcfly.com>',
  nodeMachineUrl: 'http://node-machine.org/machinepack-foo',
  docsUrl: 'http://node-machine.org/machinepack-foo',
  npmUrl: 'http://npmjs.org/package/machinepack-foo',
  sourceUrl: 'https://github.com/baz/machinepack-foo',
  githubUrl: 'https://github.com/baz/machinepack-foo',
  testsUrl: 'https://travis-ci.org/baz/machinepack-foo',
  machineDir: 'machines/',
  contributors: [ { name: 'Doc Brown', email: 'doc@brown.com' } ],
  dependencies: [ { name: 'lodash', semverRange: '^2.4.1' } ],
  license: 'MIT',
  machines: 
   [ { identity: 'do-stuff',
       friendlyName: 'Do stuff and things',
       variableName: 'doStuff',
       description: 'Do stuff given other stuff.' } ] }