note

개체에 대한 노트를 추가해요

notesRef 인수는 사용할 참조의 정규 이름이에요. 지정하지 않으면 기본값은 "refs/notes/commits"예요. force가 지정되면 이전에 존재하던 노트가 덮어써져요.

시그니처

class Repository {
  note(oid: string, note: string, options?: CreateNoteOptions | null | undefined): string;
}

파라미터

• oid필수 · string
  

  장식할 Git 개체의 OID 값이에요.

• note필수 · string
  

  해당 개체 OID에 추가할 노트의 내용이에요.

• optionsnull | CreateNoteOptions
  

  노트를 생성하기 위한 옵션이에요.

  • authorSignaturePayload
    

    노트 커밋 작성자의 서명이에요. 제공되지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.

    • email필수 · string
      

      서명에 사용되는 이메일이에요.

    • name필수 · string
      

      서명에 사용되는 이름이에요.

    • timeOptionsSignatureTimeOptions
      
      • offsetnumber
        

        시간대 오프셋(분 단위)이에요.

      • timestamp필수 · number
        

        Unix epoch 기준 초 단위 시간이에요.

  • committerSignaturePayload
    

    노트 커밋 커미터의 서명이에요. 제공되지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.

    • email필수 · string
      

      서명에 사용되는 이메일이에요.

    • name필수 · string
      

      서명에 사용되는 이름이에요.

    • timeOptionsSignatureTimeOptions
      
      • offsetnumber
        

        시간대 오프셋(분 단위)이에요.

      • timestamp필수 · number
        

        Unix epoch 기준 초 단위 시간이에요.

  • forceboolean
    

    기존 노트를 덮어쓸지 여부예요.

  • notesRefstring
    

    사용할 참조의 정규 이름이에요. 기본값은 "refs/notes/commits"예요.

반환 값

• string
  

  노트의 OID 값이에요.