Skip to content

Commit

Permalink
Add deprecation to Promise.longStackTraces docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chetbox committed Jan 15, 2016
1 parent 3ea2184 commit bda9a30
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/docs/api/promise.longstacktraces.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,21 @@ title: Promise.longStackTraces

[← Back To API Reference](/docs/api-reference.html)
<div class="api-code-section"><markdown>
##Promise.longStackTraces
## ~~Promise.longStackTraces~~

This method is deprecated. Use [Promise.config](/docs/api/promise.config.html) instead.

```js
Promise.longStackTraces() -> undefined
Promise.config({
longStackTraces: true
})
```

---

```js
Promise.longStackTraces() -> undefined
```

Call this right after the library is loaded to enabled long stack traces. Long stack traces cannot be disabled after being enabled, and cannot be enabled after promises have alread been created. Long stack traces imply a substantial performance penalty, around 4-5x for throughput and 0.5x for latency.

Expand Down Expand Up @@ -81,4 +90,4 @@ On client side, long stack traces currently only work in recent Firefoxes, Chrom
(document.getElementsByTagName("head")[0] || document.getElementsByTagName("body")[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>

0 comments on commit bda9a30

Please sign in to comment.