bump-cli/dist/core/diff.d.ts

The Bump CLI is used to interact with your API documentation hosted on Bump.sh by using the API of developers.bump.sh

import { Config } from '@oclif/core';
import { BumpApi } from '../api/index.js';
import { DiffResponse, VersionResponse, WithDiff } from '../api/models.js';
export declare class Diff {
    static readonly TIMEOUT = 120;
    private _bump;
    private _config;
    constructor(config?: Config);
    get bumpClient(): BumpApi;
    get pollingPeriod(): number;
    createDiff(file1: string, file2: string, expires: string | undefined, overlays?: string[] | undefined): Promise<DiffResponse | undefined>;
    createVersion(file: string, documentation: string, token: string, hub: string | undefined, branch_name: string | undefined, previous_version_id?: string | undefined, overlays?: string[] | undefined): Promise<VersionResponse | undefined>;
    d(formatter: any, ...args: any[]): void;
    extractDiff(versionWithDiff: VersionResponse & WithDiff): DiffResponse;
    isVersion(result: DiffResponse | VersionResponse): result is VersionResponse;
    isVersionWithDiff(result: DiffResponse | (VersionResponse & WithDiff)): result is VersionResponse & WithDiff;
    pollingDelay(): Promise<void>;
    run(file1: string, file2: string | undefined, documentation: string | undefined, hub: string | undefined, branch: string | undefined, token: string | undefined, format: string, expires: string | undefined, overlays: string[] | undefined): Promise<DiffResponse | undefined>;
    waitResult(result: DiffResponse | VersionResponse, token: string | undefined, opts: {
        format: string;
        timeout: number;
    }): Promise<DiffResponse>;
    private delay;
}