add docs for other import syntax [skip ci] (#6323)

This commit is contained in:
Henry Zhu
2017-09-27 10:29:51 -04:00
committed by GitHub
parent 508597aadc
commit c4696a5bd2

View File

@@ -1,10 +1,60 @@
# babel-helper-module-imports
## Installation
```sh
npm install babel-helper-module-imports --save
```
## Usage
### `import "source"`
```js
import { addSideEffect } from "babel-helper-module-imports";
addSideEffect(path, 'source');
```
### `import { named } from "source"`
```js
import { addNamed } from "babel-helper-module-imports";
addNamed(path, 'named', 'source');
```
### `import { named as _hintedName } from "source"`
```js
import { addNamed } from "babel-helper-module-imports";
addNamed(path, 'named', 'source', { nameHint: "hintedName" });
```
### `import _default from "source"`
```js
import { addDefault } from "babel-helper-module-imports";
addDefault(path, 'source');
```
### `import hintedName from "source"`
```js
import { addDefault } from "babel-helper-module-imports";
addDefault(path, 'source', { nameHint: "hintedName" })
```
### `import * as _namespace from "source"`
```js
import { addNamespace } from "babel-helper-module-imports";
addNamespace(path, 'source');
```
## Examples
### Adding a named import
```
```js
import { addNamed } from "babel-helper-module-imports";
export default function({ types: t }) {
@@ -16,7 +66,7 @@ export default function({ types: t }) {
importName = t.cloneDeep(importName);
} else {
// require('bluebird').coroutine
importName = this.importName = addName(path, 'coroutine', 'bluebird');
importName = this.importName = addNamed(path, 'coroutine', 'bluebird');
}
path.replaceWith(importName);