Skip to main content

Interface: AbstractVcs<TCommitContext>

@pvm/types.AbstractVcs

Type parameters

Name
TCommitContext

Hierarchy

Methods

addFiles

â–¸ addFiles(commitContext, filePaths): void

Parameters

NameType
commitContextTCommitContext
filePathsstring[]

Returns

void

Inherited from

FileCommitApi.addFiles

Defined in

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


addTag

â–¸ addTag(tag_name, ref): Promise<unknown>

Parameters

NameType
tag_namestring
refstring

Returns

Promise<unknown>

Defined in

packages/pvm-types/lib/vcs.ts:65


appendFile

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

Parameters

NameType
commitContextTCommitContext
filePathstring
contentstring

Returns

void

Inherited from

FileCommitApi.appendFile

Defined in

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


beginCommit

â–¸ beginCommit(): TCommitContext

Returns

TCommitContext

Inherited from

FileCommitApi.beginCommit

Defined in

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


commit

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

Parameters

NameType
commitContextTCommitContext
messagestring
opts?CommitOptions

Returns

Promise<CommitResult>

Inherited from

FileCommitApi.commit

Defined in

packages/pvm-types/lib/vcs.ts:60


deleteFile

â–¸ deleteFile(commitContext, file_path): void

Parameters

NameType
commitContextTCommitContext
file_pathstring

Returns

void

Inherited from

FileCommitApi.deleteFile

Defined in

packages/pvm-types/lib/vcs.ts:59


dryRun

â–¸ dryRun(): void

Returns

void

Defined in

packages/pvm-types/lib/vcs.ts:67


fetchLatestSha

â–¸ fetchLatestSha(refName): Promise<string>

Parameters

NameType
refNamestring

Returns

Promise<string>

Defined in

packages/pvm-types/lib/vcs.ts:64


getCurrentBranch

â–¸ getCurrentBranch(): string | void

Returns

string | void

Defined in

packages/pvm-types/lib/vcs.ts:68


getHeadRev

â–¸ getHeadRev(): string

Returns

string

Defined in

packages/pvm-types/lib/vcs.ts:69


isLastAvailableRef

â–¸ isLastAvailableRef(rev): boolean

Parameters

NameType
revstring

Returns

boolean

Defined in

packages/pvm-types/lib/vcs.ts:70


push

â–¸ push(opts?): Promise<void>

Parameters

NameType
opts?PushOptions

Returns

Promise<void>

Defined in

packages/pvm-types/lib/vcs.ts:66


rollbackCommit

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

Parameters

NameType
commitContextTCommitContext

Returns

Promise<void>

Inherited from

FileCommitApi.rollbackCommit

Defined in

packages/pvm-types/lib/vcs.ts:57


updateFile

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

Parameters

NameType
commitContextTCommitContext
file_pathstring
contentstring

Returns

void

Inherited from

FileCommitApi.updateFile

Defined in

packages/pvm-types/lib/vcs.ts:58