Interface: HostApi

@pvm/core.HostApi

Hierarchy

• PluginsApi

  ↳ HostApi

Properties

cwd

• cwd: string

Inherited from

PluginsApi.cwd

Defined in

packages/pvm-core/lib/plugins/index.ts:52

---

features

• features: Object

Type declaration

Name	Type
attributeReleaseData	string
commitsToNotes	string
notifyScriptsPath	string
preReleaseHook	string
releaseInfoFromReleaseCtx	string
releaseInfoFromVcs	string
releaseType	string
releaseTypeBuilder	string
releaseTypeByCommits	string

Inherited from

PluginsApi.features

Defined in

packages/pvm-core/lib/plugins/index.ts:51

Methods

addPipeline

▸ addPipeline<R>(name, fn): void

Type parameters

Name	Type
R	any

Parameters

Name	Type
name	string
fn	PipelineFn<R>

Returns

void

Inherited from

PluginsApi.addPipeline

Defined in

packages/pvm-core/lib/plugins/index.ts:62

---

attributeReleaseData

▸ attributeReleaseData(releaseData, updateState): Promise<ReleaseDataExt>

Parameters

Name	Type
releaseData	ReleaseData
updateState	null | UpdateState

Returns

Promise<ReleaseDataExt>

Defined in

packages/pvm-core/lib/plugins/index.ts:74

---

commitsToNotes

▸ commitsToNotes(commits, maybePkg?): Promise<string>

Parameters

Name	Type
commits	Commit[]
maybePkg?	void | Pkg

Returns

Promise<string>

Defined in

packages/pvm-core/lib/plugins/index.ts:68

---

getDefaultImpl

▸ getDefaultImpl<K>(feature): Features[K]

Type parameters

Name	Type
K	extends string | number

Parameters

Name	Type
feature	K

Returns

Features[K]

Inherited from

PluginsApi.getDefaultImpl

Defined in

packages/pvm-core/lib/plugins/index.ts:56

---

getOr

▸ getOr<K, D>(feature, defaultIml): D | Features[K]

Type parameters

Name	Type
K	extends string | number
D	D

Parameters

Name	Type
feature	K
defaultIml	D

Returns

D | Features[K]

Inherited from

PluginsApi.getOr

Defined in

packages/pvm-core/lib/plugins/index.ts:57

---

has

▸ has<K>(feature): boolean

Type parameters

Name	Type
K	extends string | number

Parameters

Name	Type
feature	K

Returns

boolean

Inherited from

PluginsApi.has

Defined in

packages/pvm-core/lib/plugins/index.ts:58

---

notifyScriptsPath

▸ notifyScriptsPath(): Promise<string>

Returns

Promise<string>

Defined in

packages/pvm-core/lib/plugins/index.ts:75

---

plEachSeries

▸ plEachSeries(name, ...args): Promise<any>

Parameters

Name	Type
name	string
...args	any[]

Returns

Promise<any>

Inherited from

PluginsApi.plEachSeries

Defined in

packages/pvm-core/lib/plugins/index.ts:64

---

plPipe

▸ plPipe<D>(name, initialValue, ...args): Promise<any>

Type parameters

Name
D

Parameters

Name	Type
name	string
initialValue	D
...args	any[]

Returns

Promise<any>

Inherited from

PluginsApi.plPipe

Defined in

packages/pvm-core/lib/plugins/index.ts:63

---

preReleaseHook

▸ preReleaseHook(vcs, releaseContext): Promise<void>

Parameters

Name	Type
vcs	VcsPlatform
releaseContext	ReleaseContext

Returns

Promise<void>

Defined in

packages/pvm-core/lib/plugins/index.ts:71

---

provideClass

▸ provideClass(ns, rec): void

Parameters

Name	Type
ns	string
rec	Partial<Features>

Returns

void

Inherited from

PluginsApi.provideClass

Defined in

packages/pvm-core/lib/plugins/index.ts:55

---

provideRecord

▸ provideRecord(ns, rec): void

Parameters

Name	Type
ns	string
rec	Partial<Features>

Returns

void

Inherited from

PluginsApi.provideRecord

Defined in

packages/pvm-core/lib/plugins/index.ts:54

---

provides

▸ provides<K>(feature, impl): void

Type parameters

Name	Type
K	extends string | number

Parameters

Name	Type
feature	K
impl	Features[K]

Returns

void

Inherited from

PluginsApi.provides

Defined in

packages/pvm-core/lib/plugins/index.ts:53

---

releaseInfoFromReleaseCtx

▸ releaseInfoFromReleaseCtx(releaseData, releaseContext): Promise<ReleaseDataExt>

Parameters

Name	Type
releaseData	ReleaseData
releaseContext	ReleaseContext

Returns

Promise<ReleaseDataExt>

Defined in

packages/pvm-core/lib/plugins/index.ts:72

---

releaseInfoFromVcs

▸ releaseInfoFromVcs(releaseData, vcsRelease): Promise<ReleaseDataExt>

Parameters

Name	Type
releaseData	ReleaseData
vcsRelease	VcsRelease

Returns

Promise<ReleaseDataExt>

Defined in

packages/pvm-core/lib/plugins/index.ts:73

---

releaseType

▸ releaseType(pkg, changedContext): Promise<PvmReleaseType>

Parameters

Name	Type
pkg	Pkg
changedContext	ChangedContext

Returns

Promise<PvmReleaseType>

Defined in

packages/pvm-core/lib/plugins/index.ts:70

---

releaseTypeByCommits

▸ releaseTypeByCommits(commits, defaultValue?): Promise<null | SemverReleaseType>

Parameters

Name	Type
commits	Commit[]
defaultValue?	null | SemverReleaseType

Returns

Promise<null | SemverReleaseType>

Defined in

packages/pvm-core/lib/plugins/index.ts:69

---

resolve

▸ resolve<K>(feature): Features[K]

Type parameters

Name	Type
K	extends string | number

Parameters

Name	Type
feature	K

Returns

Features[K]

Inherited from

PluginsApi.resolve

Defined in

packages/pvm-core/lib/plugins/index.ts:59

---

run

▸ run<K>(feature, ...args): ReturnType<Features[K]>

Type parameters

Name	Type
K	extends string | number

Parameters

Name	Type
feature	K
...args	any[]

Returns

ReturnType<Features[K]>

Inherited from

PluginsApi.run

Defined in

packages/pvm-core/lib/plugins/index.ts:60

---

runOr

▸ runOr<K, D>(feature, defaultValue, ...args): D | ReturnType<Features[K]>

Type parameters

Name	Type
K	extends string | number
D	D

Parameters

Name	Type
feature	K
defaultValue	D
...args	any[]

Returns

D | ReturnType<Features[K]>

Inherited from

PluginsApi.runOr

Defined in

packages/pvm-core/lib/plugins/index.ts:61