Sha256: cb4510ddfe95f54e6d6d28db89a2203d640674df4079f4b082cda887c670b92a
Contents?: true
Size: 1.37 KB
Versions: 3
Compression:
Stored size: 1.37 KB
Contents
<img src="http://i.imgur.com/ypw29XY.png" align="right"/>
# umd
Universal Module Definition for use in automated build systems
## Source Format
In order for the UMD wrapper to work the source code for your module should `return` the export, e.g.
```javascript
function method() {
//code
}
method.helper = function () {
//code
}
return method;
```
For examples, see the examples directory. The CommonJS module format is also supported by passing true as the second argument to methods.
## API
### umd(name, [commonJS = false], [source])
The `name` should the the name of the module. Use a string like name, all lower case with hyphens instead of spaces.
If CommonJS is `true` then it will accept CommonJS source instead of source code which `return`s the module.
If `source` is provided and is a string, then it is wrapped in umd and returned as a string. If it is not provided, a duplex stream is returned which wraps the modules (see examples/build.js).
Both commonJS and source are optional and can be provided in either order.
### umd.prelude(module, [commonJS = false])
return the text which will be inserted before a module.
### umd.postlude(module, [commonJS = false])
return the text which will be inserted after a module.
## License
MIT
Version data entries
3 entries across 3 versions & 2 rubygems