@pvm/update

Enumerations

• UpdateReasonType

Classes

• ChangedContext
• MdTableBuilder
• MdUpdatedTable
• TagAnnotation
• UpdateState

Interfaces

• AnnotatedReleaseTag
• ChangedContextAsyncDerivatives
• ChangedContextOptions
• ChangedContextState
• CliUpdateOpts
• ColumnBuilder
• ForceReleaseState
• GetUpdateStateOpts
• MakeUpdateStateOptions
• MarkReleaseTypeOpts
• ReleaseContext
• ReleaseOpts
• SinceLastReleaseOpts
• UpdateMethod
• UpdateTableRow
• VcsInitForUpdateOpts

Type aliases

UpdateContext

Ƭ UpdateContext: HintsContext

Defined in

packages/pvm-update/lib/update-context.ts:5

Variables

aliases

• aliases: "release"

Defined in

packages/pvm-update/cli/pvm-update.ts:12

---

command

• command: "local <update>"

Defined in

packages/pvm-update/cli/pvm-update-local.ts:6

---

description

• description: "Enables local mode for the following command"

Defined in

packages/pvm-update/cli/pvm-update-local.ts:7

Functions

addSuffixToSemverTagName

▸ addSuffixToSemverTagName(config, seed, semverTag): string

Parameters

Name	Type
config	Config
seed	string
semverTag	string

Returns

string

Defined in

packages/pvm-update/lib/release-name.ts:87

---

analyzeUpdate

▸ analyzeUpdate(updateState): AnalyzeResult

Parameters

Name	Type
updateState	UpdateState

Returns

AnalyzeResult

Defined in

packages/pvm-update/lib/update-methods/analyze.ts:9

---

autolint

▸ autolint(config): Promise<void>

Parameters

Name	Type
config	Config

Returns

Promise<void>

Defined in

packages/pvm-update/lib/release/prepare.ts:10

---

builder

▸ Const builder(yargs): Argv<Omit<Object, "update-option" | "update-method" | "dry-run" | "release-data-file" | "tag-only"> & InferredOptionTypes<Object>>

Parameters

Name	Type
yargs	Argv<Object>

Returns

Argv<Omit<Object, "update-option" | "update-method" | "dry-run" | "release-data-file" | "tag-only"> & InferredOptionTypes<Object>>

Defined in

packages/pvm-update/cli/pvm-update-local.ts:8

---

calcGenericTagName

▸ calcGenericTagName(config, seed): string

Parameters

Name	Type
config	Config
seed	string

Returns

string

Defined in

packages/pvm-update/lib/release-name.ts:113

---

createReleaseContext

▸ createReleaseContext(updateState): Promise<ReleaseContext | null>

Parameters

Name	Type
updateState	UpdateState

Returns

Promise<ReleaseContext | null>

Defined in

packages/pvm-update/lib/release/release-context.ts:127

---

decreaseReleaseTypeForPackagesWithZeroMajorVersion

▸ decreaseReleaseTypeForPackagesWithZeroMajorVersion(pkgVersion, releaseType): PvmReleaseType

Parameters

Name	Type
pkgVersion	string
releaseType	PvmReleaseType

Returns

PvmReleaseType

Defined in

packages/pvm-update/lib/pkg-release-type.ts:177

---

default

▸ default(maybeWords): string[]

Parameters

Name	Type
maybeWords	string | string[]

Returns

string[]

Defined in

packages/pvm-update/lib/resolve-words.ts:4

---

enrichByDependants

▸ enrichByDependants(repo, updateState, packages): Promise<Pkg[]>

Parameters

Name	Type
repo	Repository
updateState	UpdateState
packages	Iterable<Pkg>

Returns

Promise<Pkg[]>

Defined in

packages/pvm-update/lib/enrich-from-hints.ts:64

---

getUpdateState

▸ getUpdateState(opts?): Promise<UpdateState>

Parameters

Name	Type
opts	GetUpdateStateOpts

Returns

Promise<UpdateState>

Defined in

packages/pvm-update/lib/index.ts:117

---

handler

▸ Const handler(): void

Returns

void

Defined in

packages/pvm-update/cli/pvm-update-local.ts:18

---

makeAnnotatedReleaseTag

▸ makeAnnotatedReleaseTag(repo, applyMap): Promise<AnnotatedReleaseTag>

Parameters

Name	Type
repo	Repository
applyMap	Map<Pkg, AppliedPkg>

Returns

Promise<AnnotatedReleaseTag>

Defined in

packages/pvm-update/lib/release/release-context.ts:48

---

makeReleaseContext

▸ makeReleaseContext(targetRef?, opts?): Promise<ReleaseContext | null>

Parameters

Name	Type
targetRef	undefined | string
opts	MakeReleaseContextOpts

Returns

Promise<ReleaseContext | null>

Defined in

packages/pvm-update/lib/index.ts:205

---

makeUpdateState

▸ makeUpdateState(changedContext, opts?): Promise<UpdateState>

Parameters

Name	Type
changedContext	ChangedContext
opts	MakeUpdateStateOptions

Returns

Promise<UpdateState>

Defined in

packages/pvm-update/lib/index.ts:62

---

markReleaseType

▸ markReleaseType(pkg, updateState, opts?): Promise<void>

Parameters

Name	Type
pkg	Pkg
updateState	UpdateState
opts	MarkReleaseTypeOpts

Returns

Promise<void>

Defined in

packages/pvm-update/lib/pkg-release-type.ts:76

---

prepare

▸ prepare(config): Promise<void>

Parameters

Name	Type
config	Config

Returns

Promise<void>

Defined in

packages/pvm-update/lib/release/prepare.ts:25

---

processAffectedByDependants

▸ processAffectedByDependants(repo, updateState, targetPackages): Promise<Pkg[]>

Parameters

Name	Type
repo	Repository
updateState	UpdateState
targetPackages	Iterable<Pkg>

Returns

Promise<Pkg[]>

Defined in

packages/pvm-update/lib/dependants-updater.ts:16

---

processForceRelease

▸ processForceRelease(updateState): Promise<ForceReleaseState>

Parameters

Name	Type
updateState	UpdateState

Returns

Promise<ForceReleaseState>

Defined in

packages/pvm-update/lib/enrich-from-hints.ts:27

---

release

▸ release(): ReturnType<typeof makeRelease.run>

Returns

ReturnType<typeof makeRelease.run>

Defined in

packages/pvm-update/lib/index.ts:272

---

run

▸ run(updateState): Promise<string | void>

Parameters

Name	Type
updateState	UpdateState

Returns

Promise<string | void>

Defined in

packages/pvm-update/lib/update-methods/analyze.ts:44

---

update

▸ update<R>(updateMethod, opts?): Promise<R>

Type parameters

Name
R

Parameters

Name	Type
updateMethod	UpdateMethod<R>
opts	undefined | CliUpdateOpts

Returns

Promise<R>

Defined in

packages/pvm-update/lib/index.ts:212

---

updateStateToDot

▸ updateStateToDot(updateState): string

Parameters

Name	Type
updateState	UpdateState

Returns

string

Defined in

packages/pvm-update/lib/update-methods/dot.ts:93

---

vcsInitForUpdate

▸ vcsInitForUpdate(opts?): Promise<VcsPlatform>

Parameters

Name	Type
opts	VcsInitForUpdateOpts

Returns

Promise<VcsPlatform>

Defined in

packages/pvm-update/lib/vcs-init.ts:26