<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [HelloWorld](#helloworld)
    -   [shout](#shout)
    -   [wave](#wave)
-   [hello_async](#hello_async)
-   [hello](#hello)

## HelloWorld

Main class, called HelloWorld

**Examples**

```javascript
var HelloWorld = require('index.js');
var HW = new HelloWorld();
         OR
var HW = new HelloWorld('yo');
```

### shout

Shout a phrase really loudly by adding an exclamation to the end, asynchronously

**Parameters**

-   `string` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** phrase to shout
-   `args` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** different ways to shout
    -   `args.louder` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** adds exclamation points to the string
-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** from whence the shout comes, returns a string

**Examples**

```javascript
var HW = new HelloWorld();
HW.shout('rawr', { louder: true }, function(err, shout) {
  if (err) throw err;
  console.log(shout); // => 'rawr!'
});
```

### wave

Say howdy to the world

**Examples**

```javascript
var wave = HW.wave();
console.log(wave); // => 'howdy world!'
```

Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** a happy-go-lucky string saying hi

## hello_async

This is a standalone function (async) that logs a string.

**Parameters**

-   `args` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** different ways to alter the string
    -   `args.louder` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** adds exclamation points to the string
-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** from whence the hello comes, returns a string

**Examples**

```javascript
var module = require('./path/to/lib/index.js');
module.hello_async({ louder: true }, function(err, result) {
  if (err) throw err;
  console.log(result); // => "...threads are busy async bees...world!!!!"
});
```

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** an ever-so-slightly customizable string

## hello

This is a standalone function (sync) that logs a string.

**Examples**

```javascript
var module = require('./path/to/lib/index.js');
var check = module.hello();
console.log(check); // => "world"
```

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** "world"
