Skip to content

Commit c876ce0

Browse files
committed
chore: update package configuration for ESM support and add Rollup for building
1 parent e40f3db commit c876ce0

File tree

6 files changed

+934
-34
lines changed

6 files changed

+934
-34
lines changed

nodejs/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,55 @@ npm install @hackmd/api --save
2222

2323
## Example
2424

25+
### ES Modules (ESM)
26+
2527
```javascript
28+
// Default import
2629
import HackMDAPI from '@hackmd/api'
2730

31+
// Or named import
32+
import { API } from '@hackmd/api'
33+
2834
const client = new HackMDAPI('YOUR_ACCESS_TOKEN' /* required */, 'https://api.hackmd.io/v1' /* optional */)
2935

3036
client.getMe().then(me => {
3137
console.log(me.email)
3238
})
3339
```
3440

41+
### CommonJS
42+
43+
```javascript
44+
// Default import
45+
const HackMDAPI = require('@hackmd/api').default
46+
47+
// Or named import
48+
const { API } = require('@hackmd/api')
49+
50+
const client = new HackMDAPI('YOUR_ACCESS_TOKEN', 'https://api.hackmd.io/v1')
51+
52+
client.getMe().then(me => {
53+
console.log(me.email)
54+
})
55+
```
56+
57+
### Legacy Import Support
58+
59+
For backward compatibility, the package also supports legacy import paths:
60+
61+
```javascript
62+
// ESM
63+
import HackMDAPI from '@hackmd/api/dist'
64+
import { API } from '@hackmd/api/dist'
65+
66+
// CommonJS
67+
const HackMDAPI = require('@hackmd/api/dist').default
68+
const { API } = require('@hackmd/api/dist')
69+
70+
// Direct file imports
71+
import { API } from '@hackmd/api/dist/index.js'
72+
```
73+
3574
## Advanced Features
3675

3776
### Retry Configuration

0 commit comments

Comments
 (0)