Documentation
    Preparing search index...

    Interface GitForgeAdapterInterface

    interface GitForgeAdapterInterface {
        context: ForgeContext;
        forgeType: ForgeType;
        authStatus(): Promise<AuthStatus>;
        createBranch(branchName: string, fromBranch?: string): Promise<void>;
        downloadBlob(sha: string): Promise<string>;
        fetchFileTree(branch?: string): Promise<FileTreeNode[]>;
        getCliInstallHint(): string;
        getExecutionMode(): Promise<"cli" | "http">;
        isCliAvailable(): Promise<boolean>;
        passthrough(args: string[]): Promise<number>;
        prCheckout(prNumber: number): Promise<void>;
        prCreate(options: PrCreateOptions): Promise<PullRequest>;
        prList(options?: PrListOptions): Promise<PullRequest[]>;
        prMerge(prNumber: number, options?: PrMergeOptions): Promise<void>;
        prView(prNumber: number): Promise<PullRequest>;
        pull(branch?: string): Promise<void>;
        push(files: CommitFile[], message: string, branch?: string): Promise<void>;
        releaseCreate(options: ReleaseCreateOptions): Promise<void>;
        repoClone(target: string, destination?: string): Promise<void>;
        repoCreate(options: RepoCreateOptions): Promise<RepoDetails>;
        repoView(): Promise<RepoDetails>;
        whoami(): Promise<string>;
    }

    Implemented by

    Index

    Properties

    context forgeType

    Methods

    authStatus createBranch downloadBlob fetchFileTree getCliInstallHint getExecutionMode isCliAvailable passthrough prCheckout prCreate prList prMerge prView pull push releaseCreate repoClone repoCreate repoView whoami

    Properties

    context: ForgeContext
    forgeType: ForgeType

    Methods

    • Returns Promise<AuthStatus>

    • Parameters

      • branchName: string
      • OptionalfromBranch: string

      Returns Promise<void>

    • Parameters

      • sha: string

      Returns Promise<string>

    • Parameters

      • Optionalbranch: string

      Returns Promise<FileTreeNode[]>

    • Returns string

    • Returns Promise<"cli" | "http">

    • Returns Promise<boolean>

    • Parameters

      • args: string[]

      Returns Promise<number>

    • Parameters

      • prNumber: number

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • prNumber: number

      Returns Promise<PullRequest>

    • Parameters

      • Optionalbranch: string

      Returns Promise<void>

    • Parameters

      • files: CommitFile[]
      • message: string
      • Optionalbranch: string

      Returns Promise<void>

    • Parameters

      • target: string
      • Optionaldestination: string

      Returns Promise<void>

    • Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods