Interface: AbstractVcs<TCommitContext>

@pvm/vcs.AbstractVcs

Type parameters

Name
TCommitContext

Hierarchy

• FileCommitApi<TCommitContext>

  ↳ AbstractVcs

Methods

addFiles

▸ addFiles(commitContext, filePaths): void

Parameters

Name	Type
commitContext	TCommitContext
filePaths	string[]

Returns

void

Inherited from

FileCommitApi.addFiles

Defined in

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

---

addTag

▸ addTag(tag_name, ref): Promise<unknown>

Parameters

Name	Type
tag_name	string
ref	string

Returns

Promise<unknown>

Defined in

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

---

appendFile

▸ appendFile(commitContext, filePath, content): void

Parameters

Name	Type
commitContext	TCommitContext
filePath	string
content	string

Returns

void

Inherited from

FileCommitApi.appendFile

Defined in

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

---

beginCommit

▸ beginCommit(): TCommitContext

Returns

TCommitContext

Inherited from

FileCommitApi.beginCommit

Defined in

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

---

commit

▸ commit(commitContext, message, opts?): Promise<CommitResult>

Parameters

Name	Type
commitContext	TCommitContext
message	string
opts?	CommitOptions

Returns

Promise<CommitResult>

Inherited from

FileCommitApi.commit

Defined in

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

---

deleteFile

▸ deleteFile(commitContext, file_path): void

Parameters

Name	Type
commitContext	TCommitContext
file_path	string

Returns

void

Inherited from

FileCommitApi.deleteFile

Defined in

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

---

dryRun

▸ dryRun(): void

Returns

void

Defined in

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

---

fetchLatestSha

▸ fetchLatestSha(refName): Promise<string>

Parameters

Name	Type
refName	string

Returns

Promise<string>

Defined in

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

---

getCurrentBranch

▸ getCurrentBranch(): string | void

Returns

string | void

Defined in

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

---

getHeadRev

▸ getHeadRev(): string

Returns

string

Defined in

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

---

isLastAvailableRef

▸ isLastAvailableRef(rev): boolean

Parameters

Name	Type
rev	string

Returns

boolean

Defined in

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

---

push

▸ push(opts?): Promise<void>

Parameters

Name	Type
opts?	PushOptions

Returns

Promise<void>

Defined in

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

---

rollbackCommit

▸ rollbackCommit(commitContext): Promise<void>

Parameters

Name	Type
commitContext	TCommitContext

Returns

Promise<void>

Inherited from

FileCommitApi.rollbackCommit

Defined in

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

---

updateFile

▸ updateFile(commitContext, file_path, content): void

Parameters

Name	Type
commitContext	TCommitContext
file_path	any
content	any

Returns

void

Inherited from

FileCommitApi.updateFile

Defined in

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