Skip to content

Commit 0547162

Browse files
committed
Update types in README.md to match the new types in the code
1 parent e98882a commit 0547162

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,32 @@ gitDiffParser.parse(gitDiffText);
2121
### API
2222

2323
```ts
24-
export interface Change {
24+
export type ChangeType = 'insert' | 'delete' | 'normal';
25+
26+
export interface InsertChange {
27+
type: 'insert';
2528
content: string;
26-
type: 'insert' | 'delete' | 'normal';
27-
isInsert?: boolean;
28-
isDelete?: boolean;
29-
isNormal?: boolean;
30-
lineNumber?: number;
31-
oldLineNumber?: number;
32-
newLineNumber?: number;
29+
lineNumber: number;
30+
isInsert: true;
3331
}
3432

33+
export interface DeleteChange {
34+
type: 'delete';
35+
content: string;
36+
lineNumber: number;
37+
isDelete: true;
38+
}
39+
40+
export interface NormalChange {
41+
type: 'normal';
42+
content: string;
43+
isNormal: true;
44+
oldLineNumber: number;
45+
newLineNumber: number;
46+
}
47+
48+
export type Change = InsertChange | DeleteChange | NormalChange;
49+
3550
export interface Hunk {
3651
content: string;
3752
oldStart: number;
@@ -41,6 +56,8 @@ export interface Hunk {
4156
changes: Change[];
4257
}
4358

59+
export type FileType = 'add' | 'delete' | 'modify' | 'rename' | 'copy';
60+
4461
export interface File {
4562
hunks: Hunk[];
4663
oldEndingNewLine: boolean;
@@ -53,7 +70,7 @@ export interface File {
5370
oldPath: string;
5471
newPath: string;
5572
isBinary?: boolean;
56-
type: 'add' | 'delete' | 'modify''rename';
73+
type: FileType;
5774
}
5875

5976
export function parse(source: string): File[];

0 commit comments

Comments
 (0)