Class: Git::Commands::Stash::Clear Private

Inherits:

Base

• Object
• Base
• Git::Commands::Stash::Clear

Defined in:

lib/git/commands/stash/clear.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Note:

arguments block audited against https://git-scm.com/docs/git-stash/2.53.0

Remove all stash entries

Removes all stash entries. Use with caution as this cannot be undone.

Examples:

Clear all stashes

Git::Commands::Stash::Clear.new(execution_context).call

See Also:

• Git::Commands::Stash for usage examples
• git-stash documentation

Instance Method Summary

• #call ⇒ Git::CommandLineResult

  Clear all stash entries.

Methods inherited from Base

allow_exit_status, arguments, #initialize, requires_git_version, skip_version_validation

Constructor Details

This class inherits a constructor from Git::Commands::Base

Instance Method Details

#call ⇒ Git::CommandLineResult

Returns the result of calling git stash clear.

Clear all stash entries

Returns:

• (Git::CommandLineResult) —

  the result of calling git stash clear

Raises:

• (Git::FailedError) —

  if git exits with a non-zero exit status

# File 'lib/git/commands/stash/clear.rb', line 29