npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@commont/sdk

v0.0.3

Published

Effortlessly add a comment section to your website, and start the discussion on your content.

Downloads

7

Readme

@commont/sdk

npm

Getting set up

To use Commont, you need to create a new account via our signup page. You can sign up using an email and password or by using GitHub or Google. Once you have an account, you can access the Commont dashboard. Initially, you'll see one default project that you can configure as you need.

👀 Read the docs for more information.

Installing @commont/sdk

yarn add @commont/sdk commont # npm install @commont/sdk

The package exports a Commont function that you can use to initialize the client.

Using the Commont client

Commont function takes two arguments:

  • projectId — Your project ID.
  • config — An optional argument of type CommontSdkConfig. You can configure whether commont client should return errors or throw errors. By default it does the former.

It returns an object with methods getComments and addComment.

Example usage

import { Commont } from '@commont/sdk';

const commont = Commont('my-project');

const res = await commont.getComments('my-blogpost');

if ('error' in res) {
  console.error(res.error);
  return;
}

console.log(res.comments, res.count);

const newComment = await commont.addComment('/my-blogpost', {
  author: 'me',
  content: 'Hello world!',
  details: {
    optionalKey: 'optional value',
  },
});

With throwErrors: true

import { Commont } from '@commont/sdk';

const commont = Commont('my-project', { throwErrors: true });

try {
  const res = await commont.getComments('my-project');
} catch (err) {
  console.error(err);
}

Examples

API Reference

Comment

export interface Comment {
  author: string;
  content: string;
  topic: string;
  createdAt: string;
  details?: Record<string, any>;
}

GetCommentsOptions

export interface GetCommentsOptions {
  take?: number;
  skip?: number;
}

GetCommentsResult

export type GetCommentsResult = {
  comments: Comment[];
  count: number;
};

CommontSdkConfig

export interface CommontSdkConfig {
  /** @default false */
  throwErrors?: boolean;
}

PossiblyCommontError

export type PossiblyCommontError<
  TOptions extends CommontSdkConfig
> = TOptions['throwErrors'] extends true ? never : CommontSDKError;

CommontSDKError

export class CommontSDKError extends Error {
  constructor(public error: string) {
    super(error);
  }
}