Alinex Util: Readme

This module will be used as incubator for different small helper methods which are generally used for different general class types:

• general helper
• string helper
• number helper
• array helper
• object helper

It is one of the modules of the Alinex Namespace following the code standards defined in the General Docs.

Read the complete documentation under https://alinex.github.io/node-util.

Install

See the {@link Changelog.md} for a list of changes in recent versions.

The easiest way is to let npm add the module directly to your modules (from within you node modules directory):

npm install alinex-util --save

General Usage

All methods in this package can be called from the util object:

util = require 'alinex-util'
raw = { eins: 1 }
copy = util.clone raw
console.log util.inspect copy

Or you may directly import only the needed objects with:

{string, object} = require 'alinex-util'
array = require 'alinex-util/lib/mod/array'

The first example load all methods, while the second example only load the needed type library.

The library may be used as replacement for the node util package because it also exports the {@link util.inspect} method from NodeJS core which is the only really needed method from this package.

License

(C) Copyright 2014-2017 Alexander Schilling

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.