Nevertheless! Party Metaphorically
Wondering what’s next for npm?Check out our public roadmap! »

hashnode-sdk-js
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

📦 hashnode-sdk-js

npm version GitHub license

Hashnode SDK for JavaScript/TypeScript (unofficial).

What is this?

This is a library for working with Hashnode programmatically in JavaScript/TypeScript, it's built around Hashnode API.

Key concepts

  • Opinionated, has its own interfaces focusing on common blogging features, e.g. CRUD articles, comments, etc (what you usually do on Hashnode).

  • Abstracts away Hashnode API, which is currently in alpha and subject to breaking changes. Whereas, this SDK's API is considerably stable, its API won't change without a major release. As soon as Hashnode API changes, it will be updated to keep its API remain unchanged and function correctly.

  • Not flexible by design, you can't query less or more fields, these use cases are covered by Hashnode GraphQL API.

How & why?

I (@phuctm97) is actively using this SDK in my website to implement an auto-crosspost workflow, which runs daily. Hence, as soon as something breaks, I'll recognize and fix as soon as possible. Check out this workflow run to see how it is used in practice.

Usage

Install

yarn add hashnode-sdk-js

API

Configure API key

Go to Hashnode account settings, create an API key and set it as environment variable HASHNODE_API_KEY at where you run your application, the SDK will automatically use it.

Find a user by username

import hashnode from "hashnode-sdk-js";

hashnode.findUser("phuctm97").then((data) => console.log(data));
{
  id: '5fa3f68b47631a19e811f076',
  username: 'phuctm97',
  name: 'Minh-Phuc Tran',
  tagline: 'Engineer 👨🏻‍💻. Building open-source tools and tutorials ➡️ twitter.com/phuctm97',
  publication: {
    id: '5fa565080163314ab6d7deab',
    name: "Minh-Phuc Tran's Blog",
    domain: 'blog.phuctm97.com'
  }
}

Other examples

See examples.

Types

export type Publication = {
  id: string;
  name: string;
  domain: string;
};

export type User = {
  id: string;
  username: string;
  name: string;
  tagline: string;
  publication: Publication;
};

export type Article = {
  id: string;
  title: string;
  slug: string;
  url: string;
  canonicalURL?: string;
  contentMarkdown: string;
};

Features

  • [x] Find user.

  • [x] Get a user's publication.

  • [x] Create an article in a publication.

  • [x] Update an article in a publication.

  • [ ] Delete an article.

  • [ ] Get feed.

  • ... (contributions are welcome)


Made by @phuctm97.

Install

npm i hashnode-sdk-js

DownloadsWeekly Downloads

4

Version

1.0.1

License

MIT

Unpacked Size

18.9 kB

Total Files

24

Last publish

Collaborators

  • avatar