Skip to content

add promise polyfill documentation #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

add promise polyfill documentation #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
263e977
add promise polyfill documentation
brooswit Apr 9, 2018
5145922
Merge branch 'master' of github.com:launchdarkly/js-client into jw/ch…
brooswit Apr 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,28 @@ The LaunchDarkly client-side JavaScript SDK supports the following browsers:

\* These browsers do not support streaming new flags to connected clients, even when `client.on('change')` is called.

### Promies polyfill
Copy link
Contributor

@eli-darkly eli-darkly Apr 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: Promies

Our SDK provides promise interfaces and uses promises internally. Many modern web browsers support promises, but to ensure the SDK works on older browsers you must include a polyfil such as [es6-promise](https://github.com/stefanpenner/es6-promise).

You can find a graph showing browser promises support [here](https://caniuse.com/#feat=promises).

You can load the polyfll via a script tag in the `<head>`:
Copy link
Contributor

@atrakh atrakh Apr 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo- polyfll -> polyfill


<script src="/public/promise.js"></script>

or load es6-promise from via CDN:

<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/es6-promise@4/dist/es6-promise.auto.min.js"></script>

You can also install the es6-promise polyfill using a package manager:

yarn add es6-promise

or

npm install es6-promise

### EventSource polyfill

If you need streaming support, and you wish to support browsers that do not support `EventSource` natively, you can install a polyfill, such
Expand Down