Skip to content

docs: add ESM import documentation #1022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
taronsung wants to merge 1 commit into
base: master
Choose a base branch
from
+31 −0
Open

docs: add ESM import documentation #1022

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,37 @@ workb();
The `DEBUG` environment variable is then used to enable these based on space or
comma-delimited names.

### ESM (ECMAScript Modules)

When using ESM with `import` syntax, you can import `debug` as follows:

```js
import debug from 'debug';

const log = debug('app:log');

log('booting %o', 'My App');
```

If you want to use a different variable name for the factory function:

```js
import debug from 'debug';

const createDebug = debug;
const log = createDebug('app:log');
```

For TypeScript users, the same import syntax works:

```ts
import debug from 'debug';

const log = debug('http');

log('request received');
```

Here are some examples:

<img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png">
Expand Down