utilsxo/README.md

A small, portable library full of utilities, functions, and neat tricks for your project/application

# UtilsX Module
### Version 1.0.0

## What is UtilsX?

UtilsX is a module written by Curtis Gervais, designed to be a compact, easy-to-use, dependency-less way to do multiple functions, such as convert arrays/strings/bytes, basic security filtering, and convert functions from other languages (such as... golang, python, php), and allow easy access to them.

## What components does UtilsX have?

UtilsX has the following compontent sections:

`` utilsx.convert.*``

``utilsx.security.*``

``utilsx.misc.*``

``utilsx.test.*``

## Require it!

```
var utilsx = require('utilsxo');
```

## What's in Convert?

Note: All items encased in [] are optional.

```
utilsx.convert.asString(Data, [callback]);
```

```
utilsx.convert.asByte(Data, [callback]);
```

```
utilsx.convert.toNumber/.toInt/.toNum(Data);
```

```
utilsx.convert.number_format(number, [decimals], [decPoint], [thousandsSep]);
```

```
utilsx.convert.strToArray(string);
```

```
utilsx.convert.arrayToStr(array);
```

```
utilsx.convert.jsonToArray(json_data);
```

```
utilsx.convert.arrayToJson(array_data);
```

## What's in Security?

Note: All items encased in [] are optional.

```
utilsx.security.basic(string to be cleaned (filters for ", ', <, >));
```

```
utilsx.security.strip_tags(string);
```

```
utilsx.security.full(string); // filters for everything in both functions above
```

## What's in Misc/Test?

Functions in test are not to be used in production, moreover are included for development/future function testing. Please do **not** rely on them for production.

```
utilsx.misc.count(array/object);
```

```
utilsx.misc.create_function(args, code);
```

```
utilsx.misc.index(item, seperator);
```

```
utilsx.misc.lastIndex(item, seperator);
```

```
utilsx.misc.capwords(string);
```

```
utilsx.test.section(number_of_seperation_marks);
```

### Want to see them in action?
Check the tests folder on Github, to see all **stable, production-usable** functions in action.