describe

커밋을 설명해요

이 commitish Git 개체에 대해 describe 연산을 수행해요.

시그니처

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

파라미터

• optionsnull | DescribeOptions
  

  describe 연산에 대한 옵션이에요.

  • describeAllboolean
    

    참조 조회 전략을 설정해요. git-describe의 --all 옵션처럼 동작해요.

  • describeTagsboolean
    

    참조 조회 전략을 설정해요. git-describe의 --tags 옵션처럼 동작해요.

  • maxCandidatesTagsnumber
    

    태그 후보의 최대 개수예요.

  • onlyFollowFirstParentboolean
    

    일치하는 태그나 참조로부터 거리를 계산할 때, 첫 번째 부모 계보만 따라갈지 여부를 나타내는 값이에요.

  • patternstring
    

    태그나 참조를 필터링할 때 사용할 패턴 문자열이에요.

  • showCommitOidAsFallbackboolean
    

    일치하는 태그나 참조를 찾지 못해 describe 연산이 보통 실패하는 경우에 대한 동작을 결정해요. 이 옵션이 설정되면 실패하는 대신 커밋의 전체 id를 보여줘요.

반환 값

• Describe
  

  describe 인스턴스예요.