gulp-paginationator

gulp-paginationator

Gulp plugin using paginationator to create pagination data for vinyl files coming through the stream.

Install

Install with npm:

$ npm install --save gulp-paginationator

Usage

var paginationator = require('gulp-paginationator');

API

paginationator

Uses paginationator to add pagination data to each file coming through the stream.

Params

• options {Object}: Options to control which files are paginated and where the data is put.
• options.prop {String}: This is the property that the pagination data will be set on. Defaults to pager.
• options.filter {Function}: Function that may be used to control which files are paginated.
• options.sort {Function}: Function that may be used to sort the files before paginating.
• returns {Stream}: Stream to be passed to .pipe that will add pagination data to each file.

Example

gulp.task('default', function() {
  return gulp.src(['*.hbs'])
    .pipe(paginationator())
    .on('data', function(file) {
      console.log(file);
      console.log(file.data.pager);
    });
});

Examples

See the examples folder showing each of the options. Run examples using node directly:

$ node examples
$ node examples/prop.js
$ node examples/filter.js
$ node examples/sort.js

options.prop

Change the property that pagination data is stored on.

gulp.task('default', function() {
  return gulp.src(['*.hbs'])
    .pipe(paginationator({prop: 'pagination'}))
    .on('data', function(file) {
      console.log(file);
      console.log(file.data.pagination);
    });
});

options.filter

Only include specific files to be paginated. The files that are not paginated will be pushed back into the stream after the paginated files.

gulp.task('default', function() {
  return gulp.src(['*.hbs'])
    .pipe(paginationator({
      filter: function(file, i, files) {
        return (i % 2 === 0);
      }
    }))
    .on('data', function(file) {
      console.log(file);
      console.log(file.data && file.data.pager);
    });
});

options.sort

Sort the files before applying pagination.

gulp.task('default', function() {
  return gulp.src(['*.hbs'])
    .pipe(paginationator({
      sort: function(a, b) {
        if (a.stem > b.stem) return 1;
        if (a.stem < b.stem) return -1;
        return 0;
      }
    }))
    .on('data', function(file) {
      console.log(file);
      console.log(file.data.pager);
    });
});

About

Related projects

• gulp: The streaming build system | homepage
• paginationator: Paginate an array into pages of items. | homepage

Contributing

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

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

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

Brian Woodward

• github/doowb
• twitter/doowb

License

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

This file was generated by verb, v0.9.0, on August 09, 2016.