diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/load-script/Readme.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/load-script/Readme.md')
| -rw-r--r-- | node_modules/load-script/Readme.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/load-script/Readme.md b/node_modules/load-script/Readme.md new file mode 100644 index 00000000..86411052 --- /dev/null +++ b/node_modules/load-script/Readme.md @@ -0,0 +1,58 @@ +# load-script + +Dynamic script loading. + +## Installation + +via component + +``` +$ component install eldargab/load-script +``` + +via npm + +``` +$ npm install load-script +``` + +## API +`load-script` appends a `script` node to the `<head>` element in the dom. + +`require('load-script')` returns a function of the following interface: `function(url[, opts][, cb]) {}` + +### url +Any url that you would like to load. May be absolute or relative. + +### [, opts] +A map of options. Here are the currently supported options: + +* `async` - A boolean value used for `script.async`. By default this is `true`. +* `attrs` - A map of attributes to set on the `script` node before appending it to the DOM. By default this is empty. +* `charset` - A string value used for `script.charset`. By default this is `utf8`. +* `text` - A string of text to append to the `script` node before it is appended to the DOM. By default this is empty. +* `type` - A string used for `script.type`. By default this is `text/javascript`. + +### [, cb] +A callback function of the following interface: `function(err, script) {}` where `err` is an error if any occurred and `script` is the `script` node that was appended to the DOM. + +## Example Usage + +```javascript +var load = require('load-script') + +load('foo.js', function (err, script) { + if (err) { + // print useful message + } + else { + console.log(script.src);// Prints 'foo'.js' + // use script + // note that in IE8 and below loading error wouldn't be reported + } +}) +``` + +## License + +MIT |