Type alias PushParams

PushParams: {
    dir: string;
    fs: FsClient;
    http: HttpClient;
    cache?: Cache;
    delete?: boolean;
    force?: boolean;
    gitdir?: string;
    headers?: HttpHeaders;
    onAuth?: AuthCallback;
    onAuthFailure?: AuthFailureCallback;
    onAuthSuccess?: AuthSuccessCallback;
    onMessage?: MessageCallback;
    onProgress?: ProgressCallback;
    ref?: string;
    remote?: string;
    remoteRef?: string;
    url?: string;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system client.

  • http: HttpClient

    An HTTP client.

  • Optional cache?: Cache

    A cache object.

  • Optional delete?: boolean

    If true, delete the remote ref.

  • Optional force?: boolean

    If true, behaves the same as git push --force.

  • 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 onMessage?: MessageCallback

    Optional message event callback.

  • Optional onProgress?: ProgressCallback

    Optional progress event callback.

  • Optional ref?: string

    Which branch to push. 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 receiving branch on the remote. By default this is the configured remote tracking 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