nodejs

HackMD Node.js API Client

About

This is a Node.js client for the HackMD API.

You can sign up for an account at hackmd.io, and then create access tokens for your projects by following the HackMD API documentation.

For bugs and feature requests, please open an issue or pull request on GitHub.

v2.0.0 Update Note

v2.0.0 is a completely rewrite and is incompatible with v1.x.x. But the best of all, it does not require Node.JS runtime anymore, which means you can use it in a browser. We recommend you to upgrade to v2.0.0 if you are using the old one.

Installation

npm install @hackmd/api --save

Example

ES Modules (ESM)

// Default import
import HackMDAPI from '@hackmd/api'

// Or named import
import { API } from '@hackmd/api'

const client = new HackMDAPI('YOUR_ACCESS_TOKEN' /* required */, 'https://api.hackmd.io/v1' /* optional */)

client.getMe().then(me => {
  console.log(me.email)
})

CommonJS

// Default import
const HackMDAPI = require('@hackmd/api').default

// Or named import
const { API } = require('@hackmd/api')

const client = new HackMDAPI('YOUR_ACCESS_TOKEN', 'https://api.hackmd.io/v1')

client.getMe().then(me => {
  console.log(me.email)
})

Legacy Import Support

For backward compatibility, the package also supports legacy import paths:

// ESM
import HackMDAPI from '@hackmd/api/dist'
import { API } from '@hackmd/api/dist'

// CommonJS
const HackMDAPI = require('@hackmd/api/dist').default
const { API } = require('@hackmd/api/dist')

// Direct file imports
import { API } from '@hackmd/api/dist/index.js'

Advanced Features

Retry Configuration

The client supports automatic retry for failed requests with exponential backoff. You can configure retry behavior when creating the client:

const client = new HackMDAPI('YOUR_ACCESS_TOKEN', 'https://api.hackmd.io/v1', {
  retryConfig: {
    maxRetries: 3,    // Maximum number of retry attempts
    baseDelay: 100    // Base delay in milliseconds for exponential backoff
  }
})

The client will automatically retry requests that fail with:

• 5xx server errors
• 429 Too Many Requests errors
• Network errors

Response Data Handling

By default, the client automatically unwraps the response data from the Axios response object. You can control this behavior using the unwrapData option:

// Get raw Axios response (includes headers, status, etc.)
const response = await client.getMe({ unwrapData: false })

// Get only the data (default behavior)
const data = await client.getMe({ unwrapData: true })

ETag Support

The client supports ETag-based caching for note retrieval. You can pass an ETag to check if the content has changed:

// First request
const note = await client.getNote('note-id')
const etag = note.etag

// Subsequent request with ETag
const updatedNote = await client.getNote('note-id', { etag })
// If the note hasn't changed, the response will have status 304

API

See the code and typings. The API client is written in TypeScript, so you can get auto-completion and type checking in any TypeScript Language Server powered editor or IDE.

E2E tests (live API)

Integration tests call a real HackMD API (staging or production). They are not run by npm test or the default CI job.

Requirements

• HACKMD_ACCESS_TOKEN — a valid personal access token for the environment you target.
• Optional: HACKMD_API_ENDPOINT — defaults to https://api.hackmd.io/v1. For staging, use https://api-stage.hackmd.io/v1.

Read-only (default e2e)

cd nodejs
export HACKMD_ACCESS_TOKEN=your_token
export HACKMD_API_ENDPOINT=https://api-stage.hackmd.io/v1   # optional
npm run test:e2e

With CRUD / mutations

Set HACKMD_E2E_MUTATIONS=1 to run write tests against your account:

• Notes: create → get → update (title, content, tags) → list → delete.
• Folders: one integration test runs create (root + nested) → get → update → list → folder-order round-trip (skipped if that API returns 404) → delete. If POST /folders returns 404 (common before full production rollout), the test exits early with a warning; use staging or HACKMD_E2E_FOLDERS=0.

HACKMD_E2E_MUTATIONS=1 npm run test:e2e

Folder CRUD touches folder display order briefly, then restores the previous order in an afterAll hook. To skip folder mutations (e.g. production without /folders), set HACKMD_E2E_FOLDERS=0.

The read-only getFolderList test still treats HTTP 404 as “folders not available on this host yet” and passes without failing the suite.

License

MIT