Nicely Packaged Make

    @hackmd/api
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.1 • Public • Published

    HackMD Node.js API Client

    npm

    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

    import HackMDAPI 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)
    })

    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.

    License

    MIT

    Install

    npm i @hackmd/api

    DownloadsWeekly Downloads

    13

    Version

    2.2.1

    License

    MIT

    Unpacked Size

    12.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • a60814billy
    • yukaii
    • jackycute