Skip to content

Commit 9aa9566

Browse files
seokju-naseokju-na
authored
feat: add note feature (#165)
1 parent 202d872 commit 9aa9566

File tree

25 files changed

+1743
-0
lines changed

25 files changed

+1743
-0
lines changed

‎docs/ko/reference/Note/Methods/author.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# author
2+
3+
노트 작성자를 가져와요
4+
5+
## 시그니처
6+
7+
```ts
8+
class Note {
9+
author(): Signature;
10+
}
11+
```
12+
13+
### 반환 값
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-type">Signature</span>
18+
<br>
19+
<p class="param-description">노트 작성자 서명 정보</p>
20+
<ul class="param-ul">
21+
<li class="param-li">
22+
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
23+
<br>
24+
<p class="param-description">서명에 사용된 이메일 주소</p>
25+
</li>
26+
<li class="param-li">
27+
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
28+
<br>
29+
<p class="param-description">서명에 사용된 이름</p>
30+
</li>
31+
<li class="param-li">
32+
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
33+
<br>
34+
<p class="param-description">Epoch 기준 초 단위 시간</p>
35+
</li>
36+
</ul>
37+
</li>
38+
</ul>

‎docs/ko/reference/Note/Methods/committer.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# committer
2+
3+
노트 커미터를 가져와요
4+
5+
## 시그니처
6+
7+
```ts
8+
class Note {
9+
committer(): Signature;
10+
}
11+
```
12+
13+
### 반환 값
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-type">Signature</span>
18+
<br>
19+
<p class="param-description">노트 커미터 서명 정보예요</p>
20+
<ul class="param-ul">
21+
<li class="param-li">
22+
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
23+
<br>
24+
<p class="param-description">서명에 사용된 이메일이에요</p>
25+
</li>
26+
<li class="param-li">
27+
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
28+
<br>
29+
<p class="param-description">서명에 사용된 이름이에요</p>
30+
</li>
31+
<li class="param-li">
32+
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
33+
<br>
34+
<p class="param-description">epoch 기준 초 단위 시간이에요</p>
35+
</li>
36+
</ul>
37+
</li>
38+
</ul>

‎docs/ko/reference/Note/Methods/id.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# id
2+
3+
노트 개체의 id를 가져와요
4+
5+
## 시그니처
6+
7+
```ts
8+
class Note {
9+
id(): string;
10+
}
11+
```
12+
13+
### 반환 값
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-type">string</span>
18+
<br>
19+
<p class="param-description">노트 개체의 id 값</p>
20+
</li>
21+
</ul>

‎docs/ko/reference/Note/Methods/message.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# message
2+
3+
노트 메시지를 문자열로 가져와요.
4+
5+
## 시그니처
6+
7+
```ts
8+
class Note {
9+
message(): string;
10+
}
11+
```
12+
13+
### 반환 값
14+
15+
<ul class="param-ul">
16+
<li class="param-li param-li-root">
17+
<span class="param-type">string</span>
18+
<br>
19+
<p class="param-description">문자열인 노트 메시지</p>
20+
</li>
21+
</ul>
22+
23+
### 에러
24+
25+
<ul class="param-ul">
26+
<li class="param-li param-li-root">
27+
<span class="param-type">Error</span>
28+
<br>
29+
<p class="param-description">메시지가 utf-8이 아니면 오류를 던져요.</p>
30+
</li>
31+
</ul>

‎docs/ko/reference/Repository/Methods/deleteNote.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# deleteNote
2+
3+
개체에 대한 노트를 제거해요.
4+
5+
`notesRef` 인수는 사용할 참조의 정규 이름이에요.
6+
기본값은 "refs/notes/commits"예요.
7+
8+
지정된 id는 노트를 제거할 Git 개체의 Oid예요.
9+
10+
## 시그니처
11+
12+
```ts
13+
class Repository {
14+
deleteNote(id: string, options?: DeleteNoteOptions | null | undefined): void;
15+
}
16+
```
17+
18+
### 파라미터
19+
20+
<ul class="param-ul">
21+
<li class="param-li param-li-root">
22+
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
23+
<br>
24+
<p class="param-description">노트를 제거할 Git 개체의 OID예요.</p>
25+
</li>
26+
<li class="param-li param-li-root">
27+
<span class="param-name">options</span><span class="param-type">null | DeleteNoteOptions</span>
28+
<br>
29+
<p class="param-description">노트를 삭제하기 위한 옵션이에요.</p>
30+
<ul class="param-ul">
31+
<li class="param-li">
32+
<span class="param-name">author</span><span class="param-type">SignaturePayload</span>
33+
<br>
34+
<p class="param-description">노트 커밋 작성자의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.</p>
35+
<ul class="param-ul">
36+
<li class="param-li">
37+
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
38+
<br>
39+
<p class="param-description">서명에 사용되는 이메일이에요.</p>
40+
</li>
41+
<li class="param-li">
42+
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
43+
<br>
44+
<p class="param-description">서명에 사용되는 이름이에요.</p>
45+
</li>
46+
<li class="param-li">
47+
<span class="param-name">timeOptions</span><span class="param-type">SignatureTimeOptions</span>
48+
<br>
49+
<ul class="param-ul">
50+
<li class="param-li">
51+
<span class="param-name">offset</span><span class="param-type">number</span>
52+
<br>
53+
<p class="param-description">시간대 오프셋(분 단위)이에요.</p>
54+
</li>
55+
<li class="param-li">
56+
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
57+
<br>
58+
<p class="param-description">에포크 기준 초 단위 시간이에요.</p>
59+
</li>
60+
</ul>
61+
</li>
62+
</ul>
63+
</li>
64+
<li class="param-li">
65+
<span class="param-name">committer</span><span class="param-type">SignaturePayload</span>
66+
<br>
67+
<p class="param-description">노트 커밋 커미터의 서명이에요. 제공하지 않으면 리포지토리의 기본 서명을 사용해요. 리포지토리에 기본 서명이 설정되어 있지 않으면 오류가 발생해요.</p>
68+
<ul class="param-ul">
69+
<li class="param-li">
70+
<span class="param-name">email</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
71+
<br>
72+
<p class="param-description">서명에 사용되는 이메일이에요.</p>
73+
</li>
74+
<li class="param-li">
75+
<span class="param-name">name</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
76+
<br>
77+
<p class="param-description">서명에 사용되는 이름이에요.</p>
78+
</li>
79+
<li class="param-li">
80+
<span class="param-name">timeOptions</span><span class="param-type">SignatureTimeOptions</span>
81+
<br>
82+
<ul class="param-ul">
83+
<li class="param-li">
84+
<span class="param-name">offset</span><span class="param-type">number</span>
85+
<br>
86+
<p class="param-description">시간대 오프셋(분 단위)이에요.</p>
87+
</li>
88+
<li class="param-li">
89+
<span class="param-name">timestamp</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">number</span>
90+
<br>
91+
<p class="param-description">에포크 기준 초 단위 시간이에요.</p>
92+
</li>
93+
</ul>
94+
</li>
95+
</ul>
96+
</li>
97+
<li class="param-li">
98+
<span class="param-name">notesRef</span><span class="param-type">string</span>
99+
<br>
100+
<p class="param-description">사용할 참조의 정규 이름이에요. 기본값은 &quot;refs/notes/commits&quot;예요.</p>
101+
</li>
102+
</ul>
103+
</li>
104+
</ul>

‎docs/ko/reference/Repository/Methods/findNote.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# findNote
2+
3+
개체에 대한 노트를 읽어요.
4+
5+
`notesRef` 인수는 사용할 기준 참조 이름이고, 기본값은 "refs/notes/commits"예요.
6+
7+
지정된 id는 노트를 읽을 Git 개체의 Oid예요.
8+
9+
## 시그니처
10+
11+
```ts
12+
class Repository {
13+
findNote(id: string, options?: FindNoteOptions | null | undefined): Note | null;
14+
}
15+
```
16+
17+
### 파라미터
18+
19+
<ul class="param-ul">
20+
<li class="param-li param-li-root">
21+
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
22+
<br>
23+
<p class="param-description">노트를 읽을 Git 개체의 OID 값</p>
24+
</li>
25+
<li class="param-li param-li-root">
26+
<span class="param-name">options</span><span class="param-type">null | FindNoteOptions</span>
27+
<br>
28+
<p class="param-description">노트를 찾을 때 사용할 옵션</p>
29+
<ul class="param-ul">
30+
<li class="param-li">
31+
<span class="param-name">notesRef</span><span class="param-type">string</span>
32+
<br>
33+
</li>
34+
</ul>
35+
</li>
36+
</ul>
37+
38+
### 반환 값
39+
40+
<ul class="param-ul">
41+
<li class="param-li param-li-root">
42+
<span class="param-type">null | Note</span>
43+
<br>
44+
<p class="param-description">노트 인스턴스. 존재하지 않으면 <code>null</code>을 반환하는 값</p>
45+
</li>
46+
</ul>

‎docs/ko/reference/Repository/Methods/getNote.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# getNote
2+
3+
개체에 대한 노트를 읽어요.
4+
5+
`notesRef` 인수는 사용할 참조의 정식 이름이에요.
6+
기본값은 "refs/notes/commits"예요.
7+
8+
지정된 id는 노트를 읽을 Git 개체의 Oid예요.
9+
10+
## 시그니처
11+
12+
```ts
13+
class Repository {
14+
getNote(id: string, options?: FindNoteOptions | null | undefined): Note;
15+
}
16+
```
17+
18+
### 파라미터
19+
20+
<ul class="param-ul">
21+
<li class="param-li param-li-root">
22+
<span class="param-name">id</span><span class="param-required">필수</span>&nbsp;·&nbsp;<span class="param-type">string</span>
23+
<br>
24+
<p class="param-description">노트를 읽을 Git 개체의 OID예요.</p>
25+
</li>
26+
<li class="param-li param-li-root">
27+
<span class="param-name">options</span><span class="param-type">null | FindNoteOptions</span>
28+
<br>
29+
<p class="param-description">노트를 찾기 위한 옵션이에요.</p>
30+
<ul class="param-ul">
31+
<li class="param-li">
32+
<span class="param-name">notesRef</span><span class="param-type">string</span>
33+
<br>
34+
</li>
35+
</ul>
36+
</li>
37+
</ul>
38+
39+
### 반환 값
40+
41+
<ul class="param-ul">
42+
<li class="param-li param-li-root">
43+
<span class="param-type">Note</span>
44+
<br>
45+
<p class="param-description">노트의 인스턴스예요.</p>
46+
</li>
47+
</ul>
48+
49+
### 에러
50+
51+
<ul class="param-ul">
52+
<li class="param-li param-li-root">
53+
<span class="param-type">Error</span>
54+
<br>
55+
<p class="param-description">노트가 존재하지 않으면 에러를 던져요.</p>
56+
</li>
57+
</ul>

0 commit comments

Comments
 (0)