Skip to content

Commit a1ee119

Browse files
committed
Update option list and fix CLI example
1 parent f9fcd6d commit a1ee119

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

  • lib/node_modules/@stdlib/_tools/browserify/string

lib/node_modules/@stdlib/_tools/browserify/string/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ function clbk( error ) {
5353

5454
The function accepts any [browserify][browserify] `option`, as well as the following `options`:
5555

56+
- **standalone**: standalone [browserify][browserify] export name. Setting this option instructs the function to generate a UMD bundle with the supplied export name. The generated bundle will work with other module systems. If no module system is found, the export name is attached to the `window` global.
5657
- **exportName**: bundle export target. The target is the name used to load the bundle from the external environment. In contrast to a standalone UMD bundle, a require function is exposed as a global variable.
5758
- **transforms**: an `array` of [browserify][browserify] transform modules and functions (including corresponding options) to be applied during bundling.
5859
- **plugins**: an `array` of [browserify][browserify] plugins (including corresponding options) to be applied during bundling.
@@ -120,6 +121,10 @@ Options:
120121
121122
-h, --help Print this message.
122123
-V, --version Print the package version.
124+
--standalone name Generate a UMD bundle with the supplied export
125+
name. The generated bundle will work with other
126+
module systems. If no module system is found, the
127+
export name is attached to the `window` global.
123128
--export-name name Bundle export target. The target is the name used
124129
to load the bundle from the external environment.
125130
In contrast to a standalone UMD bundle, a require
@@ -154,7 +159,7 @@ Options:
154159
### Examples
155160

156161
```bash
157-
$ browserify-string --export-name beep 'require( "path" ).join;'
162+
$ browserify-string --export-name beep 'module.exports = require( "path" ).join;'
158163
```
159164

160165
</section>

0 commit comments

Comments
 (0)