Type alias PullParams

PullParams: {
    dir: string;
    fs: FsClient;
    http: HttpClient;
    author?: Author;
    cache?: Cache;
    committer?: Author;
    fastForward?: boolean;
    fastForwardOnly?: boolean;
    gitdir?: string;
    headers?: HttpHeaders;
    onAuth?: AuthCallback;
    onAuthFailure?: AuthFailureCallback;
    onAuthSuccess?: AuthSuccessCallback;
    onBlobMerge?: BlobMergeCallback;
    onMessage?: MessageCallback;
    onProgress?: ProgressCallback;
    onSign?: SignCallback;
    prune?: boolean;
    pruneTags?: boolean;
    ref?: string;
    remote?: string;
    remoteRef?: string;
    signingKey?: string;
    singleBranch?: boolean;
    url?: string;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system client.

  • http: HttpClient

    An HTTP client.

  • Optional author?: Author

    The details about the author.

  • Optional cache?: Cache

    A cache object.

  • Optional committer?: Author

    The details about the commit committer, in the same format as the author parameter. If not specified, the author details are used.

  • Optional fastForward?: boolean

    If false, only create merge commits (default: true).

  • Optional fastForwardOnly?: boolean

    Only perform simple fast-forward merges (don't create merge commits).

  • Optional gitdir?: string

    The git directory path (default: {dir}/.git).

  • Optional headers?: HttpHeaders

    Additional headers to include in HTTP requests, similar to git's extraHeader config.

  • Optional onAuth?: AuthCallback

    Optional auth fill callback.

  • Optional onAuthFailure?: AuthFailureCallback

    Optional auth rejected callback.

  • Optional onAuthSuccess?: AuthSuccessCallback

    Optional auth approved callback.

  • Optional onBlobMerge?: BlobMergeCallback

    Optional blob merge callback.

  • Optional onMessage?: MessageCallback

    Optional message event callback.

  • Optional onProgress?: ProgressCallback

    Optional progress event callback.

  • Optional onSign?: SignCallback

    A PGP signing implementation.

  • Optional prune?: boolean

    Delete local remote-tracking branches that are not present on the remote.

  • Optional pruneTags?: boolean

    Prune local tags that don’t exist on the remote, and force-update those tags that differ.

  • Optional ref?: string

    Which branch to merge into. By default this is the currently checked out branch.

  • Optional remote?: string

    If URL is not specified, determines which remote to use.

  • Optional remoteRef?: string

    The name of the branch on the remote to fetch. By default this is the configured remote tracking branch.

  • Optional signingKey?: string

    Passed to commit when creating a merge commit.

  • Optional singleBranch?: boolean

    Instead of the default behavior of fetching all the branches, only fetch a single branch.

  • Optional url?: string

    The URL of the remote repository. The default is the value set in the git config for that remote.

Settings

Member Visibility

Theme

Generated using TypeDoc