Interface: FileCommitApi<TCommitContext>
@pvm/types.FileCommitApi
Type parameters
| Name |
|---|
TCommitContext |
Hierarchy
FileCommitApi↳
AbstractVcs
Implemented by
Methods
addFiles
â–¸ addFiles(commitContext, filePaths): void
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
filePaths | string[] |
Returns
void
Defined in
packages/pvm-types/lib/vcs.ts:54
appendFile
â–¸ appendFile(commitContext, filePath, content): void
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
filePath | string |
content | string |
Returns
void
Defined in
packages/pvm-types/lib/vcs.ts:55
beginCommit
â–¸ beginCommit(): TCommitContext
Returns
TCommitContext
Defined in
packages/pvm-types/lib/vcs.ts:56
commit
â–¸ commit(commitContext, message, opts?): Promise<CommitResult>
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
message | string |
opts? | CommitOptions |
Returns
Promise<CommitResult>
Defined in
packages/pvm-types/lib/vcs.ts:60
deleteFile
â–¸ deleteFile(commitContext, file_path): void
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
file_path | string |
Returns
void
Defined in
packages/pvm-types/lib/vcs.ts:59
rollbackCommit
â–¸ rollbackCommit(commitContext): Promise<void>
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
Returns
Promise<void>
Defined in
packages/pvm-types/lib/vcs.ts:57
updateFile
â–¸ updateFile(commitContext, file_path, content): void
Parameters
| Name | Type |
|---|---|
commitContext | TCommitContext |
file_path | string |
content | string |
Returns
void