Interface Delete

Option for deleting a branch. The branch must be fully merged in its upstream branch, or in HEAD if no upstream was set.

interface Delete {
    force?: boolean;
    remote?: boolean;
    toDelete: string;
}

Properties

force?: boolean

When set to true, then allows deleting the branch irrespective of its merged status. false by default.

remote?: boolean

When set to true then deletes the remote-tracking branches as well. It is false by default.

toDelete: string

The name of the branch to delete.