bal-util

Benjamin Lupton's Utility Functions

Common utility functions for Node.js used and maintained by Benjamin Lupton

Install

NPM

• Install: npm install --save bal-util
• Module: require('bal-util')

Browserify

• Install: npm install --save bal-util
• Module: require('bal-util')
• CDN URL: //wzrd.in/bundle/bal-util@2.8.0

Ender

• Install: ender add bal-util
• Module: require('bal-util')

Editions

This package is published with the following editions:

• bal-util aliases bal-util/index.js which uses Editions to automatically select the correct edition for the consumers environment
• bal-util/source/index.coffee is Source + CoffeeScript + Require
• bal-util/esnext/index.js is CoffeeScript Compiled + ESNext + Require
• bal-util/es2015/index.js is CoffeeScript Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

Best off looking at source, it's well documented, and there are plenty of tests

Abstraction

We're working to breaking out every part of bal-util into their own modules, or to use existing modules where there is now a more abstract version. Below are the list of the following abstractions that have been made:

• ambi < balUtilFlow.fireWithOptionalCallback
• binaryextensions < balUtilPaths.binaryExtensions
• detect-indentation < balUtilHTML.detectIndentation
• eachr < balUtilFlow.each
• event-emitter-grouped < balUtilEvents.EventEmitterEnhanced
• extendr < balUtilFlow.(extend|clone|etc)
• extract-opts < balUtilFlow.extractOptsAndCallback
• getsetdeep < balUtilFlow.(get|set)Deep
• ignorefs < balUtilPaths.isIgnoredPath
• ignorepatterns < balUtilPaths.ignoreCommonPatterns
• istextorbinary < balUtilPaths.(isTextSync|isText|getEncodingSync|getEncoding)
• remove-indentation < balUtilHTML.removeIndentation
• rimraf < balUtilPaths.rmdirDeep
• ropo < balUtilHTML.(getAttribute|replaceElement|replaceElementAsync)
• safecallback < balUtilFlow.safeCallback
• safefs < balUtilPaths.(openFile|closeFile|etc)
• safeps < balUtilModules
• scandirectory < balUtilPaths.scandir
• taskgroup < balUtilFlow.Group
• textextensions < balUtilPaths.textExtensions
• trim-indentation < balUtilHTML.removeIndentation
• typechecker < balUtilTypes

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Sean Fridman — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2011+ Benjamin Lupton

and licensed under:

• MIT License

Changelog

v2.8.0 2018 June 10

• Removed the HTML utilities, as they are now extracted out
• Updated base files