cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[skip ci] update babel-core's README

Browse Source
This commit is contained in:
Sven SAULEAU
2016-12-17 12:41:49 +01:00
committed by GitHub
parent 77d9e3e5c4
commit 3ef8e61d72
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/babel-core/README.md
View File

@@ -9,7 +9,9 @@ import { transform } from 'babel-core';
import * as babel from 'babel-core';
```
## babel.transform(code: string, [options?](/docs/usage/api/#options): Object)
All transformation will use your local configuration files (.babelrc or in package.json). See [options](#options) to disable it.
## babel.transform(code: string, [options?](#options): Object)
Transforms the passed in `code`. Returning an object with the generated code,
source map, and AST.
@@ -27,7 +29,7 @@ result.map;
result.ast;
```
## babel.transformFile(filename: string, [options?](/docs/usage/api/#options): Object, callback: Function)
## babel.transformFile(filename: string, [options?](#options): Object, callback: Function)
Asynchronously transforms the entire contents of a file.
@@ -43,7 +45,7 @@ babel.transformFile("filename.js", options, function (err, result) {
});
```
## babel.transformFileSync(filename: string, [options?](/docs/usage/api/#options): Object)
## babel.transformFileSync(filename: string, [options?](#options): Object)
Synchronous version of `babel.transformFile`. Returns the transformed contents of
the `filename`.
@@ -58,7 +60,7 @@ babel.transformFileSync(filename, options) // => { code, map, ast }
babel.transformFileSync("filename.js", options).code;
```
## babel.transformFromAst(ast: Object, code?: string, [options?](/docs/usage/api/#options): Object)
## babel.transformFromAst(ast: Object, code?: string, [options?](#options): Object)
Given, an [AST](https://astexplorer.net/), transform it.