Skip to content
This repository has been archived by the owner on Oct 9, 2020. It is now read-only.

Commit

Permalink
Merge pull request #816 from CxRes/master
Browse files Browse the repository at this point in the history
Added warning that module names exist in URL space
  • Loading branch information
guybedford committed Jun 28, 2017
2 parents 458b5d4 + 411cb84 commit 3385a9c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ Concatenate all modules in the tree or module tree expression and optionally wri

`tree`: A tree object as returned from builder.trace(), or one of the arithmetic functions
`expression`: A [module tree expression](#module-tree-expressions)
`moduleNames`: An array of exact, unnormalized module names
`moduleNames`: An array of exact, unnormalized module names \
**Important**: The module names in `expression` or `moduleNames` should only be `/` separated (On Windows, do NOT use `\` as your path separator for this argument). The module names are specified in URL space; in particular, they are not file-paths. \
`outfile`: The file to write out the bundle to
`options`: Additional bundle options as outlined below

Expand Down Expand Up @@ -112,7 +113,8 @@ builder.bundle('moduleA.js', { minify:true }).then((bundle) => {
Similar to builder.bundle() but builds a self-executing bundle

`tree`: A tree object as returned from builder.trace(), or one of the arithmetic functions
`expression`: A [module tree expression](#module-tree-expressions)
`expression`: A [module tree expression](#module-tree-expressions) \
**Important**: The module names in `expression` or `moduleNames` should only be `/` separated (On Windows, do NOT use `\` as your path separator for this argument). The module names are specified in URL space; in particular, they are not file-paths. \
`outfile`: The file to write out the bundle to
`options`: Additional bundle options as outlined in `builder.bundle()`

Expand All @@ -127,7 +129,8 @@ builder.buildStatic('moduleA.js').then((sfxBundle) => {
### builder.trace(expression)
Creates the module tree object represented by `expression`

`expression`: A [module tree expression](#module-tree-expressions)
`expression`: A [module tree expression](#module-tree-expressions) \
**Important**: The module names in `expression` should only be `/` separated (On Windows, do NOT use `\` as your path separator for this argument). The module names are specified in URL space; in particular, they are not file-paths.

Returns a promise which resolves with the module tree

Expand Down

0 comments on commit 3385a9c

Please sign in to comment.