format

이 describe 결과를 출력하고, 결과를 문자열로 반환해요.

시그니처

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

파라미터

• optionsnull | DescribeFormatOptions
  

  describe를 포맷하기 위한 옵션이에요.

  • abbreviatedSizenumber
    

    사용할 축약된 커밋 ID의 길이를 설정해요. 이 값은 축약 문자열 길이의 하한이고, 기본값은 7이에요.

  • alwaysUseLongFormatboolean
    

    더 짧은 이름을 사용할 수 있는 경우에도 항상 긴 형식을 사용할지 여부를 설정해요.

  • dirtySuffixstring
    

    작업 디렉터리가 dirty 상태이고 이 값이 설정된 경우, 이 문자열을 description 문자열 끝에 덧붙여요.

반환 값

• string
  

  이 describe에 대한 포맷된 문자열이에요.