format

Prints this describe result, returning the result as a string.

Signature

class Describe {
  format(options?: DescribeFormatOptions | null | undefined): string;
}

Parameters

• optionsnull | DescribeFormatOptions
  

  Options for formatting describe.

  • abbreviatedSizenumber
    

    Sets the size of the abbreviated commit id to use. The value is the lower bound for the length of the abbreviated string, and the default is 7.

  • alwaysUseLongFormatboolean
    

    Sets whether or not the long format is used even when a shorter name could be used.

  • dirtySuffixstring
    

    If the workdir is dirty and this is set, this string will be appended to the description string.

Returns

• string
  

  Formatted string for this describe.