/usr/share/doc/node-umd/README.md is in node-umd 3.0.1+ds-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | # umd
<img src="http://i.imgur.com/ypw29XY.png" align="right"/>
Universal Module Definition for use in automated build systems
- simple synchronous wrapping of a string
- `return` style module support
- CommonJS support
- prevents internal UMDs from conflicting
[](https://travis-ci.org/ForbesLindesay/umd)
[](https://gemnasium.com/ForbesLindesay/umd)
[](http://badge.fury.io/js/umd)
## 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
options:
- `commonJS` (default: `false`) - If commonJS is `true` then it will accept CommonJS source instead of source code which `return`s the module.
### umd(name, source, [options])
The `name` should the the name of the module. Use a string like name, all lower case with hyphens instead of spaces.
If `source` should be a string, that is wrapped in umd and returned as a string.
### umd.prelude(module, [options])
return the text which will be inserted before a module.
### umd.postlude(module, [options])
return the text which will be inserted after a module.
## Command Line
```
Usage: umd <name> <source> <destination> [options]
Pipe Usage: umd <name> [options] < source > destination
Options:
-h --help Display usage information
-c --commonJS Use CommonJS module format
```
You can easilly pipe unix commands together like:
```js
cat my-module.js | umd my-module | uglify-js > my-module.umd.min.js
```
## Name Casing and Characters
The `name` passed to `umd` will be converted to camel case (`my-library` becomes `myLibrary`) and may only contain:
* alphanumeric characters
* $
* _
The name may not begin with a number. Invalid characters will be stripped.
## License
MIT
|