# hunterslogger

> A utility for managing console logs within a JavaScript application

Latest version **1.0.3** (published 2017-07-25) · MIT license · 0 weekly downloads

## Install

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

## 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.0.3 |
| Published | 2017-07-25 |
| First published | 2017-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Hunter Hodnett |
| Maintainers | hunterchristian |
| Keywords | logger |

## Links

- npm: https://www.npmjs.com/package/hunterslogger
- Repository: https://github.com/hunterchristian/logger
- Homepage: https://github.com/hunterchristian/logger#readme
- Issues: https://github.com/hunterchristian/logger/issues
- npm.io page: https://npm.io/package/hunterslogger

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2017-07-25
- 1.0.2 — 2017-07-25
- 1.0.1 — 2017-07-24
- 1.0.0 — 2017-07-24

## README

[![Build Status](https://travis-ci.org/hunterchristian/logger.svg?branch=master)](https://travis-ci.org/hunterchristian/logger)

# logger
A utility for managing console logs within a JavaScript application. This utility allows for centralized control over
the format of application logs.

##### Tables of contents
* [Installing](#installing)
* [Usage](#usage)  
* [Documentation generated from JSDocs in source code](#classes)  
* [Contributing](#contributing)  
* [Testing](#testing)  

<a name="installing"></a>
# Installing
`npm install --save hunterslogger`

<a name="usage"></a>
# Usage

```javascript
import Logger from 'hunterslogger';
const logger = new Logger('nameOfThisFile');

...

logger.log('your log message');
logger.warn('your warning');
logger.error('your error');
```
<a name="classes"></a>
## Classes

<dl>
<dt><a href="#Logger">Logger</a></dt>
<dd></dd>
</dl>

## Functions

<dl>
<dt><a href="#verifyVariableIsType">verifyVariableIsType(variable, type)</a></dt>
<dd><p>Verify that a given variable is of a particular type.</p>
</dd>
</dl>

<a name="Logger"></a>

## Logger
**Kind**: global class  

* [Logger](#Logger)
    * [new Logger(moduleName)](#new_Logger_new)
    * [.log(message)](#Logger+log)
    * [.warn(message)](#Logger+warn)
    * [.error(message)](#Logger+error)

<a name="new_Logger_new"></a>

### new Logger(moduleName)
Conctructor


| Param | Type | Description |
| --- | --- | --- |
| moduleName | <code>String</code> | name of the module that is consuming Logger |

<a name="Logger+log"></a>

### logger.log(message)
Log a message to the browser console

**Kind**: instance method of [<code>Logger</code>](#Logger)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | message to be logged |

<a name="Logger+warn"></a>

### logger.warn(message)
Log a warning to the console

**Kind**: instance method of [<code>Logger</code>](#Logger)  

| Param | Type |
| --- | --- |
| message | <code>String</code> | 

<a name="Logger+error"></a>

### logger.error(message)
Log an error to the console

**Kind**: instance method of [<code>Logger</code>](#Logger)  

| Param | Type |
| --- | --- |
| message | <code>String</code> | 

<a name="verifyVariableIsType"></a>

## verifyVariableIsType(variable, type)
Verify that a given variable is of a particular type.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| variable | <code>\*</code> | the variable being verified |
| type | <code>String</code> | the expected type of the variable |

<a name="contributing"></a>
# Contributing
1. Pull down the code into a local git repo
2. Install the development dependencies: `npm install`
3. Make your changes (be sure to have unit tests covering your changes)
4. Run the unit tests: `npm run test`
5. If all of the unit tests pass, build the source code: `npm run build`
6. Submit a pull request :)

<a name="testing"></a>
# Testing
Tests are run with Jasmine: https://jasmine.github.io/index.html
Tests can be run with the following command: `npm run test`

I wanted to maintain a build status, so I decided to use Travis CI after finding the following StackOverflow answer after
some googling: https://stackoverflow.com/questions/13546097/how-do-show-my-tests-passing-failing-in-github

Since specs are written using ES2015 syntax, spec files must be transpiled using babel. I detail how I created this build
step below.

When I initially attempted to run the Jasmine unit tests, I received the following error in the console:
```javascript
Hunters-MacBook-Pro:logger hunterhodnett$ ./node_modules/.bin/jasmine
/Users/hunterhodnett/PersonalProjects/logger/spec/logger.spec.js:5
import Logger from '../src/logger.js';
^^^^^^
SyntaxError: Unexpected token import
```

This led me to the following StackOverflow question: https://stackoverflow.com/questions/39436322/node-js-syntaxerror-unexpected-token-import  
...which led me to perform the following google search: https://www.google.com/search?q=jasmine+spec+babel&rlz=1C5CHFA_enUS725US725&oq=jasmine+spec+babel&aqs=chrome..69i57.5799j0j4&sourceid=chrome&ie=UTF-8  
...which led me to the following gist (first result in google search): https://gist.github.com/mauvm/172878a9646095d03fd7  
...which led me to create the run.js file in the /spec directory, as well as change the "test" command (within the
"scripts" section of package.json) to "./node_modules/.bin/babel-node spec/run.js", which kicks off a transpile of run.js,
which imports and runs Jasmine from within a node environment that supports ES2015 syntax.

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