kutt/build/esm/api/Health.d.ts

Node.js & browser (TypeScript) client for Kutt url shortener

import API from "#src/API";
/**
 *
 * @see {@link https://docs.kutt.it/#tag/health}
 * @example
 * const health = new Health(config);
 */
export default class Health extends API {
    /**
     *
     * @protected
     */
    protected readonly prefix = "/health";
    /**
     * Checks API health.
     * @example
     * const isHealthy = await health.check();
     */
    check(): Promise<boolean>;
}