Skip to content

Commit 0c62ff2

Browse files
seokju-naseokju-na
authored
chore: update index.d.ts (#86)
1 parent 5a38fd5 commit 0c62ff2

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

‎index.d.ts‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,7 @@ export enum ReferenceFormat {
701701
* @category Reference
702702
* @signature
703703
* ```ts
704-
* function normalizeReferenceName(refname: string, format?: number): string | null;
704+
* function normalizeReferenceName(refname: string, format?: number | null | undefined): string | null;
705705
* ```
706706
*
707707
* @param {string} refname - Reference name to normalize.
@@ -1056,8 +1056,8 @@ export interface RepositoryCloneOptions {
10561056
* ```ts
10571057
* function initRepository(
10581058
* path: string,
1059-
* options?: RepositoryInitOptions,
1060-
* signal?: AbortSignal,
1059+
* options?: RepositoryInitOptions | null | undefined,
1060+
* signal?: AbortSignal | null | undefined,
10611061
* ): Promise<Repository>;
10621062
* ```
10631063
*
@@ -1075,15 +1075,15 @@ export interface RepositoryCloneOptions {
10751075
* ```ts
10761076
* import { initRepository } from 'es-git';
10771077
*
1078-
* const repo = await iniRepository('/path/to/repo');
1078+
* const repo = await initRepository('/path/to/repo');
10791079
* ```
10801080
*
10811081
* Create bare repository.
10821082
*
10831083
* ```ts
10841084
* import { initRepository } from 'es-git';
10851085
*
1086-
* const repo = await iniRepository('/path/to/repo.git', {
1086+
* const repo = await initRepository('/path/to/repo.git', {
10871087
* bare: true,
10881088
* });
10891089
* ```
@@ -1097,8 +1097,8 @@ export declare function initRepository(path: string, options?: RepositoryInitOpt
10971097
* ```ts
10981098
* function openRepository(
10991099
* path: string,
1100-
* options?: RepositoryOpenOptions,
1101-
* signal?: AbortSignal,
1100+
* options?: RepositoryOpenOptions | null | undefined,
1101+
* signal?: AbortSignal | null | undefined,
11021102
* ): Promise<Repository>;
11031103
* ```
11041104
*
@@ -1139,7 +1139,7 @@ export declare function openRepository(path: string, options?: RepositoryOpenOpt
11391139
* @category Repository
11401140
* @signature
11411141
* ```ts
1142-
* function discoverRepository(path: string, signal?: AbortSignal): Promise<Repository>;
1142+
* function discoverRepository(path: string, signal?: AbortSignal | null | undefined): Promise<Repository>;
11431143
* ```
11441144
*
11451145
* @param {string} path - Directory path to discover repository.
@@ -1161,8 +1161,8 @@ export declare function discoverRepository(path: string, signal?: AbortSignal |
11611161
* function cloneRepository(
11621162
* url: string,
11631163
* path: string,
1164-
* options?: RepositoryCloneOptions | null,
1165-
* signal?: AbortSignal | null
1164+
* options?: RepositoryCloneOptions | null | undefined,
1165+
* signal?: AbortSignal | null | undefined
11661166
* ): Promise<Repository>;
11671167
* ```
11681168
*
@@ -1290,7 +1290,7 @@ export interface SignatureTimeOptions {
12901290
* function createSignature(
12911291
* name: string,
12921292
* email: string,
1293-
* timeOptions?: SignatureTimeOptions,
1293+
* timeOptions?: SignatureTimeOptions | null | undefined,
12941294
* ): Signature;
12951295
* ```
12961296
*
@@ -1509,7 +1509,7 @@ export declare class Commit {
15091509
* @signature
15101510
* ```ts
15111511
* class Commit {
1512-
* summary(): string;
1512+
* summary(): string | null;
15131513
* }
15141514
* ```
15151515
*
@@ -1531,7 +1531,7 @@ export declare class Commit {
15311531
* @signature
15321532
* ```ts
15331533
* class Commit {
1534-
* body(): string;
1534+
* body(): string | null;
15351535
* }
15361536
* ```
15371537
*
@@ -2095,7 +2095,7 @@ export declare class Diff {
20952095
* @signature
20962096
* ```ts
20972097
* class Diff {
2098-
* print(options?: DiffPrintOptions | null): string;
2098+
* print(options?: DiffPrintOptions | null | undefined): string;
20992099
* }
21002100
* ```
21012101
*
@@ -2115,7 +2115,7 @@ export declare class Diff {
21152115
* @signature
21162116
* ```ts
21172117
* class Diff {
2118-
* findSimilar(options?: DiffFindOptions): void;
2118+
* findSimilar(options?: DiffFindOptions | null | undefined): void;
21192119
* }
21202120
* ```
21212121
*
@@ -2400,7 +2400,7 @@ export declare class Index {
24002400
* @signature
24012401
* ```ts
24022402
* class Index {
2403-
* setVersion(version: number): number;
2403+
* setVersion(version: number): void;
24042404
* }
24052405
* ```
24062406
*
@@ -2417,7 +2417,7 @@ export declare class Index {
24172417
* @signature
24182418
* ```ts
24192419
* class Index {
2420-
* getByPath(path: string, stage?: IndexStage): IndexEntry | null;
2420+
* getByPath(path: string, stage?: IndexStage | null | undefined): IndexEntry | null;
24212421
* }
24222422
* ```
24232423
*
@@ -2457,7 +2457,7 @@ export declare class Index {
24572457
* @signature
24582458
* ```ts
24592459
* class Index {
2460-
* addAll(pathspecs: string[], options?: IndexAddAllOptions): void;
2460+
* addAll(pathspecs: string[], options?: IndexAddAllOptions | null | undefined): void;
24612461
* }
24622462
* ```
24632463
*
@@ -2490,7 +2490,7 @@ export declare class Index {
24902490
* @signature
24912491
* ```ts
24922492
* class Index {
2493-
* read(force?: boolean): void;
2493+
* read(force?: boolean | null | undefined): void;
24942494
* }
24952495
* ```
24962496
*
@@ -2550,7 +2550,7 @@ export declare class Index {
25502550
* @signature
25512551
* ```ts
25522552
* class Index {
2553-
* removePath(path: string, options?: IndexRemoveOptions): void;
2553+
* removePath(path: string, options?: IndexRemoveOptions | null | undefined): void;
25542554
* }
25552555
* ```
25562556
*
@@ -2565,7 +2565,7 @@ export declare class Index {
25652565
* @signature
25662566
* ```ts
25672567
* class Index {
2568-
* removeAll(pathspecs: string[], options?: IndexRemoveAllOptions): void;
2568+
* removeAll(pathspecs: string[], options?: IndexRemoveAllOptions | null | undefined): void;
25692569
* }
25702570
* ```
25712571
*
@@ -2586,7 +2586,7 @@ export declare class Index {
25862586
* @signature
25872587
* ```ts
25882588
* class Index {
2589-
* updateAll(pathspecs: string[], options?: IndexUpdateAllOptions): void;
2589+
* updateAll(pathspecs: string[], options?: IndexUpdateAllOptions | null | undefined): void;
25902590
* }
25912591
* ```
25922592
*
@@ -2681,7 +2681,7 @@ export declare class GitObject {
26812681
/**
26822682
* Get the id (SHA1) of a repository object.
26832683
*
2684-
* @category Object/Methods
2684+
* @category GitObject/Methods
26852685
* @signature
26862686
* ```ts
26872687
* class GitObject {
@@ -2695,7 +2695,7 @@ export declare class GitObject {
26952695
/**
26962696
* Get the object type of object.
26972697
*
2698-
* @category Object/Methods
2698+
* @category GitObject/Methods
26992699
* @signature
27002700
* ```ts
27012701
* class GitObject {
@@ -2709,7 +2709,7 @@ export declare class GitObject {
27092709
/**
27102710
* Recursively peel an object until an object of the specified type is met.
27112711
*
2712-
* @category Object/Methods
2712+
* @category GitObject/Methods
27132713
* @signature
27142714
* ```ts
27152715
* class GitObject {
@@ -2727,7 +2727,7 @@ export declare class GitObject {
27272727
/**
27282728
* Recursively peel an object until a commit is found.
27292729
*
2730-
* @category Object/Methods
2730+
* @category GitObject/Methods
27312731
* @signature
27322732
* ```ts
27332733
* class GitObject {
@@ -2741,7 +2741,7 @@ export declare class GitObject {
27412741
/**
27422742
* Recursively peel an object until a blob is found.
27432743
*
2744-
* @category Object/Methods
2744+
* @category GitObject/Methods
27452745
* @signature
27462746
* ```ts
27472747
* class GitObject {
@@ -2755,7 +2755,7 @@ export declare class GitObject {
27552755
/**
27562756
* Attempt to view this object as a commit.
27572757
*
2758-
* @category Object/Methods
2758+
* @category GitObject/Methods
27592759
* @signature
27602760
* ```ts
27612761
* class GitObject {
@@ -2989,7 +2989,7 @@ export declare class Reference {
29892989
* @signature
29902990
* ```ts
29912991
* class Reference {
2992-
* rename(newName: string, options?: RenameReferenceOptions): Reference;
2992+
* rename(newName: string, options?: RenameReferenceOptions | null | undefined): Reference;
29932993
* }
29942994
* ```
29952995
*
@@ -3095,8 +3095,8 @@ export declare class Remote {
30953095
* class Remote {
30963096
* fetch(
30973097
* refspecs: string[],
3098-
* options?: FetchRemoteOptions,
3099-
* signal?: AbortSignal,
3098+
* options?: FetchRemoteOptions | null | undefined,
3099+
* signal?: AbortSignal | null | undefined,
31003100
* ): Promise<void>;
31013101
* }
31023102
* ```
@@ -3132,8 +3132,8 @@ export declare class Remote {
31323132
* class Remote {
31333133
* push(
31343134
* refspecs: string[],
3135-
* options?: PushOptions,
3136-
* signal?: AbortSignal,
3135+
* options?: PushOptions | null | undefined,
3136+
* signal?: AbortSignal | null | undefined,
31373137
* ): Promise<void>;
31383138
* }
31393139
* ```
@@ -3169,7 +3169,7 @@ export declare class Remote {
31693169
* @signature
31703170
* ```ts
31713171
* class Remote {
3172-
* prune(options?: PruneOptions, signal?: AbortSignal): Promise<void>;
3172+
* prune(options?: PruneOptions | null | undefined, signal?: AbortSignal | null | undefined): Promise<void>;
31733173
* }
31743174
* ```
31753175
*
@@ -3186,7 +3186,7 @@ export declare class Remote {
31863186
* @signature
31873187
* ```ts
31883188
* class Remote {
3189-
* defaultBranch(signal?: AbortSignal): Promise<string>;
3189+
* defaultBranch(signal?: AbortSignal | null | undefined): Promise<string>;
31903190
* }
31913191
* ```
31923192
*
@@ -3262,7 +3262,7 @@ export declare class Repository {
32623262
* @signature
32633263
* ```ts
32643264
* class Repository {
3265-
* commit(tree: Tree, message: string, options?: CommitOptions | null): string;
3265+
* commit(tree: Tree, message: string, options?: CommitOptions | null | undefined): string;
32663266
* }
32673267
* ```
32683268
*
@@ -3295,9 +3295,9 @@ export declare class Repository {
32953295
* ```ts
32963296
* class Repository {
32973297
* diffTreeToTree(
3298-
* oldTree?: Tree,
3299-
* newTree?: Tree,
3300-
* options?: DiffOptions,
3298+
* oldTree?: Tree | null | undefined,
3299+
* newTree?: Tree | null | undefined,
3300+
* options?: DiffOptions | null | undefined,
33013301
* ): Diff;
33023302
* }
33033303
* ```
@@ -3322,7 +3322,7 @@ export declare class Repository {
33223322
* diffIndexToIndex(
33233323
* oldIndex: Index,
33243324
* newIndex: Index,
3325-
* options?: DiffOptions,
3325+
* options?: DiffOptions | null | undefined,
33263326
* ): Diff;
33273327
* }
33283328
* ```
@@ -3346,7 +3346,7 @@ export declare class Repository {
33463346
* @signature
33473347
* ```ts
33483348
* class Repository {
3349-
* diffIndexToWorkdir(index?: Index, options?: DiffOptions): Diff;
3349+
* diffIndexToWorkdir(index?: Index | null | undefined, options?: DiffOptions | null | undefined): Diff;
33503350
* }
33513351
* ```
33523352
*
@@ -3383,7 +3383,7 @@ export declare class Repository {
33833383
* @signature
33843384
* ```ts
33853385
* class Repository {
3386-
* diffTreeToWorkdir(oldTree?: Tree, options?: DiffOptions): Diff;
3386+
* diffTreeToWorkdir(oldTree?: Tree | null | undefined, options?: DiffOptions | null | undefined): Diff;
33873387
* }
33883388
* ```
33893389
*
@@ -3407,7 +3407,7 @@ export declare class Repository {
34073407
* @signature
34083408
* ```ts
34093409
* class Repository {
3410-
* diffTreeToWorkdirWithIndex(oldTree?: Tree, options?: DiffOptions): Diff;
3410+
* diffTreeToWorkdirWithIndex(oldTree?: Tree | null | undefined, options?: DiffOptions | null | undefined): Diff;
34113411
* }
34123412
* ```
34133413
*
@@ -3579,7 +3579,7 @@ export declare class Repository {
35793579
* @signature
35803580
* ```ts
35813581
* class Repository {
3582-
* createRemote(name: string, url: string, options?: CreateRemoteOptions): Remote;
3582+
* createRemote(name: string, url: string, options?: CreateRemoteOptions | null | undefined): Remote;
35833583
* }
35843584
* ```
35853585
*
@@ -3815,7 +3815,7 @@ export declare class Repository {
38153815
* @signature
38163816
* ```ts
38173817
* class Repository {
3818-
* tagNames(pattern?: string): string[];
3818+
* tagNames(pattern?: string | null | undefined): string[];
38193819
* }
38203820
* ```
38213821
*
@@ -3889,7 +3889,7 @@ export declare class Repository {
38893889
* name: string,
38903890
* target: GitObject,
38913891
* message: string,
3892-
* options?: CreateTagOptions,
3892+
* options?: CreateTagOptions | null | undefined,
38933893
* ): string;
38943894
* }
38953895
* ```
@@ -3942,7 +3942,7 @@ export declare class Repository {
39423942
* name: string,
39433943
* target: GitObject,
39443944
* message: string,
3945-
* options?: CreateAnnotationTagOptions,
3945+
* options?: CreateAnnotationTagOptions | null | undefined,
39463946
* ): string;
39473947
* }
39483948
* ```
@@ -3967,7 +3967,7 @@ export declare class Repository {
39673967
* createLightweightTag(
39683968
* name: string,
39693969
* target: GitObject,
3970-
* options?: CreateLightweightTagOptions,
3970+
* options?: CreateLightweightTagOptions | null | undefined,
39713971
* ): string;
39723972
* }
39733973
* ```

0 commit comments

Comments
 (0)