104 lines (97 loc) · 4.79 KB

deleteNote

개체에 대한 노트를 제거해요.

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

지정된 id는 노트를 제거할 Git 개체의 Oid예요.

시그니처

class Repository {
  deleteNote(id: string, options?: DeleteNoteOptions | null | undefined): void;
}

파라미터

id필수 · string

노트를 제거할 Git 개체의 OID예요.
optionsnull | DeleteNoteOptions

노트를 삭제하기 위한 옵션이에요.
- authorSignaturePayload
  
  노트 커밋 작성자의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.
  - email필수 · string
    
    서명에 사용되는 이메일이에요.
  - name필수 · string
    
    서명에 사용되는 이름이에요.
  - timeOptionsSignatureTimeOptions
    - offsetnumber
      
      시간대 오프셋(분 단위)이에요.
    - timestamp필수 · number
      
      에포크 기준 초 단위 시간이에요.
- committerSignaturePayload
  
  노트 커밋 커미터의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.
  - email필수 · string
    
    서명에 사용되는 이메일이에요.
  - name필수 · string
    
    서명에 사용되는 이름이에요.
  - timeOptionsSignatureTimeOptions
    - offsetnumber
      
      시간대 오프셋(분 단위)이에요.
    - timestamp필수 · number
      
      에포크 기준 초 단위 시간이에요.
- notesRefstring
  
  사용할 참조의 정규 이름이에요. 기본값은 "refs/notes/commits"예요.