Class: CanaryPublishApplier

@pvm/plugin-core.CanaryPublishApplier

Hierarchy

• AbstractPublishApplier

  ↳ CanaryPublishApplier

Constructors

constructor

• new CanaryPublishApplier(repo, publishedPackages, flags)

Parameters

Name	Type
repo	Repository
publishedPackages	PkgSet<Pkg>
flags	Flags

Overrides

AbstractPublishApplier.constructor

Defined in

src/plugins/core/publish/publish-applier/canary.ts:23

Properties

canaryVersionCalcTasks

• Private canaryVersionCalcTasks: PkgMap<PromiseLike<string>, Pkg>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:18

---

canaryVersions

• Private canaryVersions: PkgMap<string, Pkg>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:17

---

flags

• Private flags: Flags

Defined in

src/plugins/core/publish/publish-applier/canary.ts:20

---

publishedPackages

• Private publishedPackages: PkgSet<Pkg>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:19

---

repo

• repo: Repository

Inherited from

AbstractPublishApplier.repo

Defined in

src/plugins/core/publish/publish-applier/abstract.ts:11

Methods

applyActualDeps

▸ applyActualDeps(pkg): Promise<AppliedPkg>

Parameters

Name	Type
pkg	Pkg

Returns

Promise<AppliedPkg>

Inherited from

AbstractPublishApplier.applyActualDeps

Defined in

src/plugins/core/publish/publish-applier/abstract.ts:23

---

applyForPublish

▸ applyForPublish(pkg): Promise<AppliedPkg>

Parameters

Name	Type
pkg	Pkg

Returns

Promise<AppliedPkg>

Inherited from

AbstractPublishApplier.applyForPublish

Defined in

src/plugins/core/publish/publish-applier/abstract.ts:38

---

asyncSafeCalcCanaryVersion

▸ asyncSafeCalcCanaryVersion(pkg, unifiedBaseCanaryIndex): Promise<string>

Parameters

Name	Type
pkg	Pkg
unifiedBaseCanaryIndex	undefined | number

Returns

Promise<string>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:70

---

calcCanaryVersion

▸ calcCanaryVersion(pkg, registry, preid, unifiedBaseCanaryIndex): Promise<string>

Parameters

Name	Type
pkg	Pkg
registry	string
preid	string
unifiedBaseCanaryIndex	undefined | number

Returns

Promise<string>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:82

---

getPkgPublishVersion

▸ getPkgPublishVersion(pkg): Promise<string>

Parameters

Name	Type
pkg	Pkg

Returns

Promise<string>

Overrides

AbstractPublishApplier.getPkgPublishVersion

Defined in

src/plugins/core/publish/publish-applier/canary.ts:66

---

prepare

▸ prepare(): Promise<void>

Returns

Promise<void>

Overrides

AbstractPublishApplier.prepare

Defined in

src/plugins/core/publish/publish-applier/canary.ts:29

---

prepareUnifiedCanaryVersion

▸ prepareUnifiedCanaryVersion(unifiedBaseCanaryIndex): Promise<void>

Algorithm in here - taking max canary version index across all packages with given preid. Then incrementing it and use as common canary index that fits to all packages.

Parameters

Name	Type
unifiedBaseCanaryIndex	undefined | number

Returns

Promise<void>

Defined in

src/plugins/core/publish/publish-applier/canary.ts:39

---

getNextCanaryIndex

▸ Static Private getNextCanaryIndex(versionString, preid): number

Parameters

Name	Type
versionString	string
preid	string

Returns

number

Defined in

src/plugins/core/publish/publish-applier/canary.ts:151