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

@flub71/checkcentral

v1.0.3

Published

A robust and intuitive Node.js client for interacting with the CheckCentral API. Seamlessly fetch overviews, checks, activities, dashboards, and more with minimal setup.

Downloads

5

Readme

CheckCentral-Node

A robust and intuitive Node.js client for interacting with the CheckCentral API. Seamlessly fetch overviews, checks, activities, dashboards, and more with minimal setup.

Installation

Install the package via npm:

npm i @flub71/checkcentral

Configuration

Before using the CheckCentral API client, you need to configure your environment:

  1. Create a .env file in the root directory of your project.
  2. Add the following line to the .env file:
    CHECK_CENTRAL_READONLY_API_KEY=YOUR_API_KEY_HERE
    Replace YOUR_API_KEY_HERE with your actual CheckCentral API key.

Usage

After installation, you can use the CheckCentralAPI class in your project. First, you need to instantiate the class with your API key:

import CheckCentralAPI from '@flub71/checkcentral';

const api = new CheckCentralAPI(process.env.CHECK_CENTRAL_READONLY_API_KEY);

async function fetchAllChecks() {
    const checks = await api.getAllChecks();
    console.log(checks);
}

fetchAllChecks();

API Methods

Here are the available methods in the CheckCentralAPI class:

  • getOverview(): Fetches an overview.
  • getAllChecks(params: AllChecksParams): Fetches all checks based on the provided parameters.
  • getActivities(params: ActivitiesParams): Fetches activities based on the provided parameters.
  • getCheckGroups(params: CheckGroupsParams): Fetches check groups based on the provided parameters.
  • getDashboards(params: DashboardsParams): Fetches dashboards based on the provided parameters.
  • getIssues(): Fetches all issues.
  • getPermissions(params: PermissionsParams): Fetches permissions based on the provided parameters.
  • generateReport(params: ReportParams): Generates a report based on the provided parameters.
  • getReports(params: ReportParams): Fetches reports based on the provided parameters.
  • getUsers(params: UsersParams): Fetches users based on the provided parameters.
  • getUserGroups(params: UserGroupsParams): Fetches user groups based on the provided parameters.

Contributing

If you'd like to contribute or have any issues/suggestions, please submit an issue or pull request on the GitHub repository.

License

This project is licensed under the MIT License.