describe

Describes a commit

Performs a describe operation on this commitish object.

Signature

class Object {
  describe(options?: DescribeOptions | null | undefined): Describe;
}

Parameters

• optionsnull | DescribeOptions
  

  Options for describe operation.

  • describeAllboolean
    

    Sets the reference lookup strategy This behaves like the --all option to git-describe.

  • describeTagsboolean
    

    Sets the reference lookup strategy This behaves like the --tags option to git-describe.

  • maxCandidatesTagsnumber
    
  • onlyFollowFirstParentboolean
    

    Indicates when calculating the distance from the matching tag or reference whether to only walk down the first-parent ancestry.

  • patternstring
    
  • showCommitOidAsFallbackboolean
    

    If no matching tag or reference is found whether a describe option would normally fail. This option indicates, however, that it will instead fall back to showing the full id of the commit.

Returns

• Describe
  

  Instance of describe.