diff --git a/doc/browser.md b/doc/browser.md index 3f55b52097..9020654359 100644 --- a/doc/browser.md +++ b/doc/browser.md @@ -3,12 +3,6 @@ A browser version of 6to5 is available from `browser.js` inside the 6to5 directory in an npm release. -## API - -```javascript -to5.transform("class Test {}").code; -``` - ## Scripts While it's not recommended for serious use, when the browser version is included @@ -47,3 +41,21 @@ To test 6to5 in your browser run: $ make test-browser And open `test/browser.html` in your browser if it doesn't open automatically. + +## API + +### to5.transform(code, [opts]) + +See [options](usage.md#options) for additional documentation. + +```javascript +to5.transform("class Test {}").code; +``` + +### to5.run(code, [opts]) + +See [options](usage.md#options) for additional documentation. + +```javascript +to5.run("class Test {}"); +``` diff --git a/doc/usage.md b/doc/usage.md index f693262979..554583d337 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -50,16 +50,28 @@ Compile and run `test.js`. ```javascript var to5 = require("6to5"); +``` +### to5.transform(code, [opts]); + +```javascript var result = to5.transform("code();", options); result.code; result.map; result.ast; +``` +### to5.transformFileSync(filename, [opts]) + +```javascript to5.transformFileSync("filename.js", options).code; +``` +### to5.transformFile(filename, [opts], callback) + +```javascript to5.transformFile("filename.js", options, function (err, result) { - + result.code; }); ``` diff --git a/lib/6to5/browser.js b/lib/6to5/browser.js index e76451a286..65dc3f64be 100644 --- a/lib/6to5/browser.js +++ b/lib/6to5/browser.js @@ -2,13 +2,6 @@ var transform = module.exports = require("./transformation/transform"); transform.transform = transform; -transform.eval = function (code, opts) { - opts = opts || {}; - opts.filename = opts.filename || "eval"; - opts.sourceMap = "inline"; - return eval(transform(code, opts).code); -}; - transform.run = function (code, opts) { opts = opts || {}; opts.sourceMap = "inline";