Skip to main content

Interface: FileCommitApi<TCommitContext>

@pvm/vcs.FileCommitApi

Type parameters

Name
TCommitContext

Hierarchy

Implemented by

Methods

addFiles

â–¸ addFiles(commitContext, filePaths): void

Parameters

NameType
commitContextTCommitContext
filePathsstring[]

Returns

void

Defined in

packages/pvm-vcs/types/index.ts:50


appendFile

â–¸ appendFile(commitContext, filePath, content): void

Parameters

NameType
commitContextTCommitContext
filePathstring
contentstring

Returns

void

Defined in

packages/pvm-vcs/types/index.ts:51


beginCommit

â–¸ beginCommit(): TCommitContext

Returns

TCommitContext

Defined in

packages/pvm-vcs/types/index.ts:52


commit

â–¸ commit(commitContext, message, opts?): Promise<CommitResult>

Parameters

NameType
commitContextTCommitContext
messagestring
opts?CommitOptions

Returns

Promise<CommitResult>

Defined in

packages/pvm-vcs/types/index.ts:56


deleteFile

â–¸ deleteFile(commitContext, file_path): void

Parameters

NameType
commitContextTCommitContext
file_pathstring

Returns

void

Defined in

packages/pvm-vcs/types/index.ts:55


rollbackCommit

â–¸ rollbackCommit(commitContext): Promise<void>

Parameters

NameType
commitContextTCommitContext

Returns

Promise<void>

Defined in

packages/pvm-vcs/types/index.ts:53


updateFile

â–¸ updateFile(commitContext, file_path, content): void

Parameters

NameType
commitContextTCommitContext
file_pathany
contentany

Returns

void

Defined in

packages/pvm-vcs/types/index.ts:54