condensation
Version:
Package, reuse and share particles for CloudFormation projects
33 lines (29 loc) • 910 B
JavaScript
var buildHelper = require('./_buildHelper');
module.exports.NAME = 'metadata';
module.exports.PARTICLE_NAME = 'metadata';
module.exports.PARTICLE_DIR = 'metadata';
module.exports.SECTION_NAME = 'Metadata';
/**
* ```
* - particles
* |- metadata
* |- particle_name
* ```
*
* @example
* {{metadata "particle_name"}}
* @example
* {{metadata "particle_name" foo="bar"}}
* @example
* {{metadata "module:<MODULE>" 'particle_name'}}
* @example
* {{!-- to load modules with format `particles-NAME` --}}
* {{metadata "m:<NAME>" "particle_name"}}
* @memberof ParticleHelpers
* @function metadata
* @param {string} [module] - module to load with either `module:<MODULE>` or `m:<M>`
* @param {string} path - Path to the particle (file extensions optional)
* @param {...kv} [options] - Key/Value pairs to pass to the particle
* @returns {string}
*/
module.exports.helper = buildHelper('metadata');