Module logusContexts

Source

Type Aliases§

Source§

type LogusContext = { octokit: LogusOctokit } & {
    payload: Pick<Context<"organization">["payload"], "organization">;
}

Represents the general context for Logus. This context includes the octokit instance and the organization payload.

Source§

type LogusOctokit = Pick<Context["octokit"], "graphql" | "rest" | "config" | "pulls" | "repos">

Represents selected properties of the octokit object from the Probot context.

Source§

type LogusOrgConfigContext = { octokit: LogusOctokit } & { payload: { organization: { login: string } } }

Represents the context for Logus organization configuration. This context includes the octokit instance and the organization payload.

Source§

type PRLogusContext = { octokit: LogusOctokit } & {
    payload: Pick<
        Context<"pull_request">["payload"],
        "sender" | "repository",
    > & {
        pull_request: Pick<
            Context<"pull_request">["payload"]["pull_request"],
            "node_id",
        >;
    } & {
        organization: NonNullable<
            Context<"pull_request">["payload"]["organization"],
        >;
    };
}

Represents the context for pull request events in Logus. This context includes the octokit instance, sender, repository, pull request, and organization payloads.

Interfaces§

LogusLog

Interface representing logging in Logus.