dayum/README.md

Two-syllable damn generator

# Dayum

[![npm version](https://badge.fury.io/js/dayum.svg)](https://badge.fury.io/js/dayum)
[![Build Status](https://travis-ci.org/msrose/dayum.svg?branch=master)](https://travis-ci.org/msrose/dayum)

![Lily's two-syllable damn](http://25.media.tumblr.com/tumblr_lys6fkVfhK1qzfp7bo1_500.png)

Now, you can get a two-syllable damn in all of your JavaScript projects.

Install:

    npm install --save dayum

Use it:

```javascript
const dayum = require('dayum');
dayum(10); // 'daaaaaaaaaayum'
dayum.random(5, 15); // 'daaaaaaayum'
dayum.daaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaayum(); // random dayum based on the number of "a"s
dayum.dayumify({}); // creates an object with all /da+yum/ methods on it
```

If you have proxies in your environment, the number of "a"s doesn't matter. The more "a"s, the bigger the dayum, gurl.

## API

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

###

**Meta**

-   **author**: Michael Rose
-   **license**: https&#x3A;//github.com/msrose/dayum/blob/master/LICENSE

### dayum

Generates a two-syllable damn

**Parameters**

-   `count` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** The number of "a"s in the two-syllable damn (optional, default `1`)

**Examples**

```javascript
const dayum = require('dayum');
dayum(5); // 'daaaaayum'
```

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** A string representation of the two-syllable damn

#### random

Generates a two-syllable damn of random length

**Parameters**

-   `min` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** The fewest possible number of "a"s in the daymn (optional, default `1`)
-   `max` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** The greatest possible number of "a"s in the daymn (optional, default `100`)

**Examples**

```javascript
const dayum = require('dayum');
dayum.random(5, 15); // 'daaaaaaaaaaayum'
```

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** A string representation of the two-syllable damn

#### dayumify

Adds all possible dayum methods to the given object.
If the environment supports proxies (and no `count` is specified),
you'll be able to call any `/da+yum/` method. Any dayum method returns a random two-syllable
dayum based on the number of "a"s in the method.
If there are no proxies (and no `count` is specified),
you'll only be able to call `/da{1,50}yum/` by default. :'(

**Parameters**

-   `object` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** The object to dayumify.
-   `count` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** The number of dayum methods to add to `object`. 0 indicates all possible methods. (optional, default `0`)

**Examples**

```javascript
const dayum = require('dayum');
const x = dayum.dayumify({ prop: 'hi!' });
x.prop; // 'hi!'
x.daaaaaaaaaayum(); // equivalent to dayum.random(5, 15)
```

Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** A shallow copy of the given `object`, dayumified