Skip to main content

Interface: PluginsApi

@pvm/core.PluginsApi

Hierarchy

Properties

cwd

• cwd: string

Defined in

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


features

• features: Object

Type declaration

NameType
attributeReleaseDatastring
commitsToNotesstring
notifyScriptsPathstring
preReleaseHookstring
releaseInfoFromReleaseCtxstring
releaseInfoFromVcsstring
releaseTypestring
releaseTypeBuilderstring
releaseTypeByCommitsstring

Defined in

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

Methods

addPipeline

â–¸ addPipeline<R>(name, fn): void

Type parameters

NameType
Rany

Parameters

NameType
namestring
fnPipelineFn<R>

Returns

void

Defined in

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


getDefaultImpl

â–¸ getDefaultImpl<K>(feature): Features[K]

Type parameters

NameType
Kextends string | number

Parameters

NameType
featureK

Returns

Features[K]

Defined in

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


getOr

â–¸ getOr<K, D>(feature, defaultIml): D | Features[K]

Type parameters

NameType
Kextends string | number
DD

Parameters

NameType
featureK
defaultImlD

Returns

D | Features[K]

Defined in

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


has

â–¸ has<K>(feature): boolean

Type parameters

NameType
Kextends string | number

Parameters

NameType
featureK

Returns

boolean

Defined in

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


plEachSeries

â–¸ plEachSeries(name, ...args): Promise<any>

Parameters

NameType
namestring
...argsany[]

Returns

Promise<any>

Defined in

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


plPipe

â–¸ plPipe<D>(name, initialValue, ...args): Promise<any>

Type parameters

Name
D

Parameters

NameType
namestring
initialValueD
...argsany[]

Returns

Promise<any>

Defined in

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


provideClass

â–¸ provideClass(ns, rec): void

Parameters

NameType
nsstring
recPartial<Features>

Returns

void

Defined in

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


provideRecord

â–¸ provideRecord(ns, rec): void

Parameters

NameType
nsstring
recPartial<Features>

Returns

void

Defined in

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


provides

â–¸ provides<K>(feature, impl): void

Type parameters

NameType
Kextends string | number

Parameters

NameType
featureK
implFeatures[K]

Returns

void

Defined in

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


resolve

â–¸ resolve<K>(feature): Features[K]

Type parameters

NameType
Kextends string | number

Parameters

NameType
featureK

Returns

Features[K]

Defined in

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


run

â–¸ run<K>(feature, ...args): ReturnType<Features[K]>

Type parameters

NameType
Kextends string | number

Parameters

NameType
featureK
...argsany[]

Returns

ReturnType<Features[K]>

Defined in

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


runOr

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

Type parameters

NameType
Kextends string | number
DD

Parameters

NameType
featureK
defaultValueD
...argsany[]

Returns

D | ReturnType<Features[K]>

Defined in

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