docs(configuration): document external script #3898
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/webpack-docs/webpack-js-org/3365yuafr |
chenxsan
force-pushed
the
feature/document-script-externalsType
branch
from
101ebd9 to
a236dee
Compare
chenxsan
force-pushed
the
feature/document-script-externalsType
branch
from
a236dee to
ef578b5
Compare
|
|
||
| There're two syntaxes for loading external script in webpack configuration: | ||
|
|
||
| 1. `{externals: {packageName: ['http://example.com/script.js', 'global', 'property', 'property']}}` (properties are optional) |
There was a problem hiding this comment.
These example snippets are less readable than for example just showing the syntax in the code snippet. Also properties are not described well. I suggest you do two full config examples for each of the syntaxes with more details on property, property use-cases and usage.
|
|
||
| External script can be loaded from any url when `externalsType` is set to `script`. | ||
|
|
||
| There're two syntaxes for loading external script in webpack configuration: |
There was a problem hiding this comment.
Could rephrase this one when giving examples one by one
| - `'system'` | ||
| - `'promise'` - same as `'var'` but awaits the result (async module) | ||
| - `'import'` - uses `import()` to load a native EcmaScript module (async module) | ||
| - `'script'` - load script with HTML `<script>` element and use the global variable defined. |
There was a problem hiding this comment.
Is this more accessible than global variable defined? I think it assumes you understand context well enough
| - `'script'` - load script with HTML `<script>` element and use the global variable defined. | |
| - `'script'` - load script with HTML `<script>` element and store the result in a selected global variable |
There was a problem hiding this comment.
How about?:
load script exposing predefined global variables with HTML
<script>element
From what I learned so far, we can only load external scripts here with <script> element when they expose predefined global variables like jquery did with global window.jQuery and window.$, otherwise it'll fail. Also we can't use random variable name but those predefined ones in global placeholder. (I'm not 100% sured here, maybe @sokra can help confirm this)
There was a problem hiding this comment.
Yeah reads much better and also makes sense, lets get Tobias to comment if this is right tho
Co-authored-by: Eugene Hlushko <jhlushko@gmail.com>
|
Thanks! |
2 participants
closes #3806
Related issue #3772