@plattar/plattar-api/server/plattar-server.d.ts

Module for interfacing with the Plattar API (https://www.plattar.com)

export interface ServerType {
    readonly base: string;
    readonly api_read: string;
    readonly api_write: string;
    readonly cdn: string;
    readonly cdn_image: string;
    readonly analytics: string;
    readonly type: string;
}

export interface ServerOptions {
    readonly validate: boolean;
}

export interface ServerAuth {
    readonly "plattar-auth-token": string;
}

export class PlattarServer {
    constructor();
    get prod(): ServerType;
    get staging(): ServerType;
    get dev(): ServerType;
    get isProd(): boolean;
    get isStaging(): boolean;
    get isDev(): boolean;
    get authToken(): ServerAuth;
    get originLocation(): ServerType;
    auth(token: string, opt: ServerOptions | undefined = undefined): Promise<PlattarServer>;
    origin(server: ServerType, opt: ServerOptions | undefined = undefined): Promise<PlattarServer>;
    static match(serverName: "prod" | "staging" | "dev" | string): ServerType;
    static create(origin: ServerType | undefined = undefined, auth: string | undefined = undefined): PlattarServer;
    static disableTLS(): void;
    static default(): PlattarServer;
    static location(): ServerType;
}