uxrocket.utils

Missing utils/helpers library for javascript.


Keywords
utils, helpers, lodash, underscore, toolkit
License
MIT
Install
bower install uxrocket.utils

Documentation

UXRocket Utils

Missing utils/helpers library for javascript.

Build Status Coverage Dependency Status devDependency Status

GitHub version Bower version npm version

Psst! Türkçe biliyor musun? Belki senin için daha uygun olabilir; Türkçe Dökümantasyon.

Installation

Bower

$ bower install uxrocket.utils

NPM

$ npm install uxrocket.utils

Traditional way

Download package from release packages and grab file under dist folder. Remember, dist folder under master branch may not be stable.

Usage

Browser

<script src="uxrocket.utils-standalone.js"></script>

NPM

var __ = require("uxrocket.utils");

So, why there are three type of dist file?

It's because uxrocket.utils is dependent on lodash. And they are your usage options.

  • uxrocket.utils.js is single form of library which doesn't include lodash. If you already using lodash in your project; go and use it. Its gonna require lodash under npm and amd. In browser usages, you have to load lodash before uxrocket.utils or it gonna throw an error.

  • uxrocket.utils-standalone.js is includes lite version of lodash and seperates it from global scope. If you're not using lodash, and don't want or need to use it, or maybe you using something different library which uses global underscore _ (like underscore.js) and you don't want to lodash ruin it; grab this file. This package has lite version of lodash which include only functions that utils is using. And seperates lodash from global scope.

  • uxrocket.utils-with-lodash.js is includes complete latest version of lodash compatible lodash.compat.js. And not seperates it from global scope. If you want download uxrocket.utils and lodash in same file, use it.

Documentation

For edge-automatic-generated-inline-code documentation, check api documentation web site.

Todos

Please check TODOS.md

Changelog

Please check CHANGELOG.md

License

MIT, it means; use as whatever you want.