JSPM

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

Async helper that prompts the user for a value and uses the answer as context for rendering the template.

Package Exports

  • helper-ask

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 (helper-ask) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

helper-ask NPM version NPM downloads Build Status

Async helper that prompts the user for a value and uses the answer as context for rendering the template.

Install

Install with npm:

$ npm install --save helper-ask

Compatibility

This helper can be used with the following applications:

Usage

This helper requires the base-questions plugin to be registered first. Uses the ask-when library to conditionally prompt the user. See that project for available options and additional API documentation.

var ask = require('helper-ask');
var questions = require('base-questions');
var templates = require('templates');
var app = templates();

app.use(questions());

// register the helper, make sure to pass `app` to the function
app.asyncHelper('ask', ask(app));

Example

If you're using templates directly, you'll need to create a collection and add a template engine.

app.create('pages');
app.engine('*', require('engine-base'));
app.option('engine', '*');

With the other apps you should be able to do the following:

var page = app.page('foo', {content: '<%= ask("name") %>'});
app.option('askWhen', 'not-answered');
app.data('name', 'Brian');

app.render(page, function(err, view) {
  if (err) return cb(err);
  console.log(view.contents.toString());
  //=> 'Brian'
  cb();
});

API

Params

  • app {Object}
  • returns {Function}: Returns the helper function

Example

<%= ask('author.name') %>

About

Contributing

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

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && 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-generate-readme, v0.1.31, on October 01, 2016.