Skip to content

Commit

Permalink
docs: fast forward to latest master.
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenplusplus committed Aug 26, 2014
1 parent b447f67 commit d27dfad
Show file tree
Hide file tree
Showing 17 changed files with 1,021 additions and 168 deletions.
41 changes: 41 additions & 0 deletions docs/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
* [common/util~format(template, args)](#module_common/util..format)
* [common/util~noop()](#module_common/util..noop)
* [common/util~handleResp(err, resp, body, callback)](#module_common/util..handleResp)
* [common/util~is(value, type)](#module_common/util..is)
* [common/util~toArray(object)](#module_common/util..toArray)

<a name="module_common/connection"></a>
#common/connection
Expand Down Expand Up @@ -130,6 +132,8 @@ token.isExpired();
* [common/util~format(template, args)](#module_common/util..format)
* [common/util~noop()](#module_common/util..noop)
* [common/util~handleResp(err, resp, body, callback)](#module_common/util..handleResp)
* [common/util~is(value, type)](#module_common/util..is)
* [common/util~toArray(object)](#module_common/util..toArray)

<a name="module_common/util..extend"></a>
##common/util~extend(from, to)
Expand Down Expand Up @@ -205,3 +209,40 @@ Uniformly process an API response.
- callback `function` - The callback function.

**Scope**: inner function of [common/util](#module_common/util)
<a name="module_common/util..is"></a>
##common/util~is(value, type)
Check if an object is of the given type.

**Params**

- value `*` - Value to compare to.
- type `string` - Type to check against object's value.

**Scope**: inner function of [common/util](#module_common/util)
**Returns**: `boolean`
**Example**
```js
is([1, 2, 3], 'array');
// true
```

<a name="module_common/util..toArray"></a>
##common/util~toArray(object)
Convert an object into an array.

**Params**

- object `object` - Object to convert to an array.

**Scope**: inner function of [common/util](#module_common/util)
**Returns**: `array`
**Example**
```js
function aFunction() {
return toArray(arguments);
}

aFunction(1, 2, 3);
// [1, 2, 3]
```

Loading

0 comments on commit d27dfad

Please sign in to comment.