Skip to content
repopo

PackageJsonHandler

PackageJsonHandler<J, C> = (json, args) => Operation<PolicyHandlerResult> | Promise<PolicyHandlerResult>

Defined in: policyDefiners/definePackagePolicy.ts:27

A policy handler especially for policies that target package.json.

Type Parameters

Section titled “Type Parameters”

J

Section titled “J”

J

C

Section titled “C”

C

Parameters

Section titled “Parameters”

json

Section titled “json”

J

args

Section titled “args”

PolicyArgs<C>

Returns

Section titled “Returns”

Operation<PolicyHandlerResult> | Promise<PolicyHandlerResult>

Remarks

Section titled “Remarks”

Package JSON handlers can be implemented in two ways:

  • As an async function returning a Promise
  • As an Effection generator function returning an Operation

Both styles are supported to allow gradual migration and flexibility.