verdnatura-mirror
/
loopback-boot
mirror of https://github.com/strongloop/loopback-boot.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add disclaimer to JSDoc and small correction.

This commit is contained in:
crandmck 2014-06-06 10:11:46 -07:00
parent 7c255f089e
commit 18bc572c20
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
index.js
View File

@ -7,6 +7,10 @@ var addInstructionsToBrowserify = require('./lib/bundler');
* Initialize an application from an options object or * Initialize an application from an options object or
* a set of JSON and JavaScript files. * a set of JSON and JavaScript files.
* *
* > **NOTE**: This module is primarily intended for use with LoopBack 2.0.
* It _does_ work with LoopBack 1.x applications, but
* none of the LoopBack 1.x examples or generated code (scaffolding) use it.
*
* This function takes an optional argument that is either a string * This function takes an optional argument that is either a string
* or an object. * or an object.
* *
@ -32,9 +36,9 @@ var addInstructionsToBrowserify = require('./lib/bundler');
* In both cases, the function loads JavaScript files in the `/models` and * In both cases, the function loads JavaScript files in the `/models` and
* `/boot` subdirectories of the application root directory with `require()`. * `/boot` subdirectories of the application root directory with `require()`.
* *
* **NOTE:** mixing `app.boot()` and `app.model(name, config)` in multiple * **NOTE:** Mixing `bootLoopBackApp(app, bootConfig)` and `app.model(name, modelConfig)` in multiple
* files may result in models being **undefined** due to race conditions. * files may result in models being undefined due to race conditions.
* To avoid this when using `app.boot()` make sure all models are passed * To avoid this when using `bootLoopBackApp()` make sure all models are passed
* as part of the `models` definition. * as part of the `models` definition.
* *
* Throws an error if the config object is not valid or if boot fails. * Throws an error if the config object is not valid or if boot fails.