Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Commit

Permalink
[fixed] minor documentation updates; updates to the lodash interface …
Browse files Browse the repository at this point in the history
…file
  • Loading branch information
thealjey committed Feb 10, 2016
1 parent f9346b1 commit 9ce8f3e
Show file tree
Hide file tree
Showing 13 changed files with 37 additions and 16 deletions.
8 changes: 5 additions & 3 deletions docs/DevServer.html
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,8 @@ <h5>Parameters:</h5>
<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://webpack.github.io/docs/webpack-dev-server.html">webpack-dev-server</a></li>

<li><a href="http://gaearon.github.io/react-hot-loader/">React Hot Loader</a></li>
</ul>
</dd>
Expand Down Expand Up @@ -543,7 +545,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-181">line 181</a>
<a href="DevServer.js.html#sunlight-1-line-182">line 182</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -637,7 +639,7 @@ <h4 class="name" id="watchJS"><span class="type-signature"></span>watchJS()</h4>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-161">line 161</a>
<a href="DevServer.js.html#sunlight-1-line-162">line 162</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -781,7 +783,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-145">line 145</a>
<a href="DevServer.js.html#sunlight-1-line-146">line 146</a>
</li>
</ul>
</dd>
Expand Down
3 changes: 2 additions & 1 deletion docs/DevServer.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@ <h1 class="page-title">Source: DevServer.js</h1>
* @param {string} devDir - a full system path to a directory in which to put any compiled development resources
* @param {number} [port=3000] - a port at which to start the dev server
* @param {boolean} [react=true] - false to disable the react hot loader plugin
* @see {@link http://gaearon.github.io/react-hot-loader/|React Hot Loader}
* @see {@link http://webpack.github.io/docs/webpack-dev-server.html webpack-dev-server}
* @see {@link http://gaearon.github.io/react-hot-loader/ React Hot Loader}
* @example
* import {DevServer} from 'webcompiler';
* import {join} from 'path';
Expand Down
2 changes: 1 addition & 1 deletion docs/NativeProcess.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h1 class="page-title">Source: NativeProcess.js</h1>
import noop from 'lodash/noop';

/**
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess|ChildProcess}
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess ChildProcess}
* instance of a `task`
*
* @class NativeProcess
Expand Down
2 changes: 1 addition & 1 deletion docs/quicksearch.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/watch.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h1 class="page-title">Source: watch.js</h1>
* @param {string} dir - a full system path to a directory to watch
* @param {string} type - a file extension
* @param {Function} callback - a callback function
* @see {@link https://facebook.github.io/watchman/|Watchman}
* @see {@link https://facebook.github.io/watchman/ Watchman}
* @example
* import {watch} from 'webcompiler';
* import {join} from 'path';
Expand Down
20 changes: 18 additions & 2 deletions interfaces/lodash.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ declare module 'lodash/constant' {
declare function exports(value: any): any;
}

declare module 'lodash/clone' {
declare function exports(value: any): any;
}

declare module 'lodash/cloneDeep' {
declare function exports(value: any): any;
}

declare module 'lodash/isArray' {
declare function exports(value: any): boolean;
}
Expand All @@ -30,6 +38,10 @@ declare module 'lodash/camelCase' {
declare function exports(value: string): string;
}

declare module 'lodash/trim' {
declare function exports(value: string, chars: ?string): string;
}

declare module 'lodash/uniq' {
declare function exports(collection: Array<any>): Array<any>;
}
Expand All @@ -43,11 +55,11 @@ declare module 'lodash/without' {
}

declare module 'lodash/has' {
declare function exports(object: Object, path: Path): boolean;
declare function exports(object: any, path: Path): boolean;
}

declare module 'lodash/get' {
declare function exports(object: Object, path: Path, defaultValue: ?any): any;
declare function exports(object: any, path: Path, defaultValue: ?any): any;
}

declare module 'lodash/forEach' {
Expand All @@ -70,6 +82,10 @@ declare module 'lodash/find' {
declare function exports(collection: Iterable, iteratee: ?Iteratee): any;
}

declare module 'lodash/findIndex' {
declare function exports(collection: Iterable, iteratee: ?Iteratee): number;
}

declare module 'lodash/transform' {
declare function exports(collection: Iterable, iteratee: ?TransformCallback, accumulator: ?any): any;
}
Expand Down
3 changes: 2 additions & 1 deletion lib/DevServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ var LIVERELOAD_PORT = 35729,
* @param {string} devDir - a full system path to a directory in which to put any compiled development resources
* @param {number} [port=3000] - a port at which to start the dev server
* @param {boolean} [react=true] - false to disable the react hot loader plugin
* @see {@link http://gaearon.github.io/react-hot-loader/|React Hot Loader}
* @see {@link http://webpack.github.io/docs/webpack-dev-server.html webpack-dev-server}
* @see {@link http://gaearon.github.io/react-hot-loader/ React Hot Loader}
* @example
* import {DevServer} from 'webcompiler';
* import {join} from 'path';
Expand Down
2 changes: 1 addition & 1 deletion lib/NativeProcess.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ var _noop2 = _interopRequireDefault(_noop);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess|ChildProcess}
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess ChildProcess}
* instance of a `task`
*
* @class NativeProcess
Expand Down
2 changes: 1 addition & 1 deletion lib/watch.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ var client = new _fbWatchman.Client(),
* @param {string} dir - a full system path to a directory to watch
* @param {string} type - a file extension
* @param {Function} callback - a callback function
* @see {@link https://facebook.github.io/watchman/|Watchman}
* @see {@link https://facebook.github.io/watchman/ Watchman}
* @example
* import {watch} from 'webcompiler';
* import {join} from 'path';
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"npm": ">=3.0.0"
},
"scripts": {
"test": "babel-node ./node_modules/.bin/isparta cover _mocha --root src -- -R dot",
"test": "babel-node ./node_modules/.bin/isparta cover _mocha --root src -- -R nyan",
"docs-build": "babel-node bin/docs",
"lint": "eslint ./",
"build": "babel-node bin/build",
Expand Down
3 changes: 2 additions & 1 deletion src/DevServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ const LIVERELOAD_PORT = 35729,
* @param {string} devDir - a full system path to a directory in which to put any compiled development resources
* @param {number} [port=3000] - a port at which to start the dev server
* @param {boolean} [react=true] - false to disable the react hot loader plugin
* @see {@link http://gaearon.github.io/react-hot-loader/|React Hot Loader}
* @see {@link http://webpack.github.io/docs/webpack-dev-server.html webpack-dev-server}
* @see {@link http://gaearon.github.io/react-hot-loader/ React Hot Loader}
* @example
* import {DevServer} from 'webcompiler';
* import {join} from 'path';
Expand Down
2 changes: 1 addition & 1 deletion src/NativeProcess.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {spawn} from 'child_process';
import noop from 'lodash/noop';

/**
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess|ChildProcess}
* Encapsulates a {@link https://nodejs.org/api/child_process.html#child_process_class_childprocess ChildProcess}
* instance of a `task`
*
* @class NativeProcess
Expand Down
2 changes: 1 addition & 1 deletion src/watch.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const client = new Client(),
* @param {string} dir - a full system path to a directory to watch
* @param {string} type - a file extension
* @param {Function} callback - a callback function
* @see {@link https://facebook.github.io/watchman/|Watchman}
* @see {@link https://facebook.github.io/watchman/ Watchman}
* @example
* import {watch} from 'webcompiler';
* import {join} from 'path';
Expand Down

0 comments on commit 9ce8f3e

Please sign in to comment.