# am_utility_tool

> A Utility Tool

Latest version **1.3.0** (published 2017-01-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install am_utility_tool
pnpm add am_utility_tool
yarn add am_utility_tool
bun add am_utility_tool
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2017-01-25 |
| First published | 2017-01-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ashley Miller |
| Maintainers | ashmildevigner |
| Keywords | Utility, Tool |

## Links

- npm: https://www.npmjs.com/package/am_utility_tool
- npm.io page: https://npm.io/package/am_utility_tool

## Dependencies (6)

- [chai](https://npm.io/package/chai.md) ^3.5.0
- [mocha](https://npm.io/package/mocha.md) ^3.2.0
- [sinon](https://npm.io/package/sinon.md) ^1.17.7
- [yargs](https://npm.io/package/yargs.md) ^6.6.0
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [mocha-sinon](https://npm.io/package/mocha-sinon.md) ^1.1.6

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2017-01-25
- 1.2.0 — 2017-01-24
- 1.0.1 — 2017-01-19
- 1.0.0 — 2017-01-17

## README

###:cherry_blossom: Utility Tool Developed by Ashley Miller :cherry_blossom:

![AGirleyGeek Approved](https://img.shields.io/badge/AGirleyGeek-Approved-feafbc.svg)

###:cherry_blossom: Before You Install :cherry_blossom:

Before you install my **Utility Tool**, you will need an app that you developed with **NodeJS**.

###:cherry_blossom: Install :cherry_blossom:

To install my **Utility Tool**, in your CLI, change your current directory to your app's directory, and type `npm install am_utility_tool --save`. This will add **am_utility_tool** to your *package.json* file's list of dependencies and install it to your *node_modules* directory.

###:cherry_blossom: Debugging :cherry_blossom:

My **Utility Tool** lets you debug your app and display a success, an error, or a warn message in your CLI.

To use my **Utility Tool**, you will need to require **am_utility_tool** in the file you want to debug. You can do this by typing `const debug = require('am_utility_tool')` at the top of the file. Then you will need to call the debugSuccess, debugError, or debugWarn functions with an argument of a success, an error, or a warn message wherever you want to use them. For example, if you want to call the debugError function in one of your routes, your code may look like this:

```
res.status(500).json(err);
debug.debugError('The user was not successfully redirected to the long URL because of the following error: ' + err);
```

To turn debugging on, in your CLI, change your current directory to your app's directory if it's not already your current directory, and type `DEBUG=true` before you start your server.

Now if your route errors out, you will get an error message in your CLI that says, *The user was not successfully redirected to the long URL because of the following error: [error]*.

###:cherry_blossom: Version Bumping :cherry_blossom:

To bump your version, in your CLI, type
```
node vbumper.js -v [major, minor, or patch] -n [version number]
```

For example, if you want to bump the major version to 2, in your CLI, type
```
node vbumper.js -v major -n 2
```

---
_Source: https://npm.io/package/am_utility_tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._