probot/lib/types.d.ts

import express from "express";
import { WebhookEvent, Webhooks } from "@octokit/webhooks";
import LRUCache from "lru-cache";
import Redis from "ioredis";
import { Probot } from "./index";
import { Context } from "./context";
import { ProbotOctokit } from "./octokit/probot-octokit";
import { Application } from "./application";
import type { Logger, LogFn } from "pino";
export interface Options {
    privateKey?: string;
    githubToken?: string;
    appId?: number | string;
    Octokit?: typeof ProbotOctokit;
    log?: Logger;
    redisConfig?: Redis.RedisOptions | string;
    secret?: string;
    webhookPath?: string;
    logLevel?: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
    port?: number;
    host?: string;
    webhookProxy?: string;
    baseUrl?: string;
    /**
     * @deprecated `id` options is deprecated. Use `appId` instead
     */
    id?: number | string;
    /**
     * @deprecated `cert` options is deprecated. Use `privateKey` instead
     */
    cert?: string;
    /**
     * @deprecated set `Octokit` to `ProbotOctokit.defaults({ throttle })` instead
     */
    throttleOptions?: any;
}
export declare type State = {
    appId?: number;
    privateKey?: string;
    githubToken?: string;
    log: Logger;
    Octokit: typeof ProbotOctokit;
    octokit: InstanceType<typeof ProbotOctokit>;
    cache?: LRUCache<number, string>;
    webhooks: {
        path?: string;
        secret?: string;
    };
    port?: number;
    host?: string;
    webhookProxy?: string;
    baseUrl?: string;
};
export declare type ProbotWebhooks = Webhooks<WebhookEvent, Omit<Context, keyof WebhookEvent>>;
export declare type DeprecatedLogger = LogFn & Logger;
declare type deprecatedKeys = "router" | "log" | "on" | "receive" | "load" | "route" | "auth";
export declare type ApplicationFunctionOptions = {
    [K in deprecatedKeys]: Application[K];
} & {
    app: Probot;
    getRouter: (path?: string) => express.Router;
};
export declare type ApplicationFunction = (options: ApplicationFunctionOptions) => void;
export declare type ServerOptions = {
    log?: Logger;
    port?: number;
    host?: string;
    webhookPath?: string;
    webhookProxy?: string;
    Probot: typeof Probot;
};
export declare type MiddlewareOptions = {
    probot: Probot;
    [key: string]: unknown;
    /**
     * @deprecated "Probot" option is deprecated. Pass a "probot" instance instead, see https://github.com/probot/probot/pull/1431
     */
    Probot?: typeof Probot;
};
export {};