#15580 Alter invalid usage instruction in @types/bluebird-global (#15581)

* Setting bluebird-global in compilerOptions.types
  is not required, so don't mention it in that
  tone in the docs
* Mention in the docs, that it's dev's
  responsibility to provide Bluebird in the
  runtime.

Closes #15580
This commit is contained in:
d-ph
2017-04-17 16:39:23 +01:00
committed by Andy
parent 442447cbc2
commit b036cb263c

View File

@@ -11,15 +11,24 @@
*
* 2. How to use it?
*
* Add `bluebird-global` to the `types` array in your `tsconfig.json` like this:
* It should just work, but there are a couple of points to be wary about:
*
* {
* "compilerOptions": {
* "types": [
* "bluebird-global"
* ],
* }
* }
* a) If you already use `compilerOptions.types` in your `tsconfig.json`, then add `bluebird-global`
* to the list:
*
* {
* "compilerOptions": {
* "types": [
* (other types ...)
*
* "bluebird-global"
* ],
* }
* }
*
* b) Be aware, that you still need to get the global Promise symbol to be replaced with bluebird.js
* in the runtime. Do this by either importing bluebird.js via a `<script />` tag in your html or
* via importing it in your js entry file AND assigning it to the global Promise symbol.
*
* 3. Why so much effort?
*