view-get-dest

view-get-dest

Assemble plugin to add a dest property to views.

Install

Install with npm:

$ npm install view-get-dest --save

Usage

var viewGetDest = require('view-get-dest');

API

.view-get-dest

Returns a plugin function that adds a dest getter/setter to views. Getter searches for properties that may contain the actual dest. By default the properties are data.permalink, data.dest, and path. See assemble-permalinks for details on how to set data.permalink.

Properties may be overridden by passing in a configuration when setting up the plugin.

Params

• config {Object}: Plugin configuration object.
• config.props {String|Array}: Array of properties to search on the view for the dest property. Defaults to ['data.permalink', 'data.dest', 'path'].
• returns {Function}: Plugin function to be passed to app.use

Example

var config = {
  props: ['data.dest', 'data.foo']
};
app.use(getDest(config));

.dest

.dest getter/setter on view instances

Example

var dest = view.dest;
// path/to/view/dest

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

Brian Woodward

• github/doowb
• twitter/doowb

License

verb © 2016, Brian Woodward. Released under the MIT license.

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