nails-utils

0.1.0 • Public • Published

nails-framework

nails-utils

General purpose utilities used in Nails Framework and associated projects.

Included Modules

nails-utils exports every method from Hoek as well as the following modules:

Name Module
exports.Promise Bluebird
exports.is Is
exports.path path
exports.url url
exports.fs graceful-fs
exports.glob glob
exports.chalk chalk
exports.string string
exports.request request

Extra Methods

finder(options, callback)

Finds files that match a given pattern. callback is called for every file found (like Array#forEach)

options (Object)

  • pattern (String) - A Glob pattern or require path.
  • cwd (String) - Base path. Defaults to process.cwd().

options (String) The same as { pattern: String }

callback(filename, totalFiles) (Function)

  • filename (String) - The fully resolved filename.
  • totalFiles (Number) - The total number of files found.

Example

var utils = require('nails-utils');
var plugins = [];

var options = {
  pattern: './plugins/**/*.js',
  cwd: __dirname
};

utils.finder(options, function(filename, total) {
  plugins.push(require(filename));
});

random(min, max)

Returns a random Number between min and max.

  • min (Number) - Minimum Number
  • max (Number) - Maximum Number

Licence

The MIT License (MIT)

Copyright (c) 2014 James Wyse james@jameswyse.net

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i nails-utils

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • jameswyse