Skip to content

Commit 568b80a

Browse files
committed
README about source-map-support
1 parent 5a34b88 commit 568b80a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,27 @@ For documentation, usage, and examples, see: http://coffeescript.org/
7878
To suggest a feature or report a bug: http://github.com/maxtaco/coffeescript/issues
7979

8080
The source repository: https://github.com/maxtaco/coffeescript.git
81+
82+
## Note about `source-map-support`
83+
84+
Since v112.8.1 (2019-12-20), IcedCoffeeScript v3 uses `source-map-support`
85+
package to handle location mapping for stack traces for errors coming from
86+
IcedCoffeeScript code. It's enabled by default when using `iced3` to run scripts
87+
or when using `register` to enable IcedCoffeeScript in Node's module system.
88+
89+
To enable it manually (e.g. in environments other than Node.js or when not
90+
using `register`), use the following API:
91+
92+
```
93+
require('iced-coffee-script-3').installSourceMapSupport({})
94+
```
95+
96+
This function can also be called with options for `source-map-support` instead
97+
of an empty object. Available options are described in `source-map-support`
98+
README file.
99+
100+
To use the old error handler, use the following API instead:
101+
102+
```
103+
require('iced-coffee-script-3').installPrepareStackTrace()
104+
```

0 commit comments

Comments
 (0)