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

### Table of Contents

-   [HelloObjectAsync](#helloobjectasync)
    -   [helloAsync](#helloasync)
-   [HelloObject](#helloobject)
    -   [hello](#hello)
-   [helloAsync](#helloasync-1)
-   [hello](#hello-1)

## HelloObjectAsync

Asynchronous class, called HelloObjectAsync

**Examples**

```javascript
var module = require('index.js');
var Obj = new module.HelloObjectAsync('greg');
```

### helloAsync

Say hello while doing expensive work in threads

**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('index.js');
var Obj = new module.HelloObjectAsync('greg');
Obj.helloAsync({ louder: true }, function(err, result) {
  if (err) throw err;
  console.log(result); // => '...threads are busy async bees...hello greg!!!'
});
```

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

## HelloObject

Synchronous class, called HelloObject

**Examples**

```javascript
var module = require('index.js');
var Obj = new module.HelloObject('greg');
```

### hello

Say hello

**Examples**

```javascript
var x = Obj.hello();
console.log(x); // => '...initialized an object...hello greg'
```

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

## helloAsync

This is an asynchronous standalone function 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.helloAsync({ louder: true }, function(err, result) {
  if (err) throw err;
  console.log(result); // => "...threads are busy async bees...hello world!!!!"
});
```

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

## hello

This is a synchronous standalone function that logs a string.

**Examples**

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

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