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

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

import API from "#src/API";
/**
 *
 * @see {@link https://docs.kutt.it/#tag/domains}
 * @example
 * const domains = new Domain(config);
 */
export default class Domain extends API {
    /**
     *
     * @protected
     */
    protected readonly prefix = "/domains";
    /**
     * Creates a domain.
     *
     * @param domain
     * @example
     * const domain = await domains.create({
     *   address: "string",
     *   homepage: "string",
     * });
     */
    create(domain: NewDomainT): Promise<DomainI>;
    /**
     * Deletes a domain.
     *
     * @param id
     * @example
     * const message = await domains.remove(domain.id);
     */
    remove(id: string): Promise<string>;
}
export declare type NewDomainT = {
    address: string;
    homepage?: string;
};
export interface DomainI {
    address: string;
    banned: boolean;
    created_at: Date;
    homepage?: string;
    id: string;
    updated_at: Date;
}