makePolicyDefinition

makePolicyDefinition<C>(args): PolicyDefinition<C>

Defined in: makePolicy.ts:252

Creates a PolicyDefinition from the provided arguments.

Deprecated

Define policies as object literals satisfying PolicyShape instead.

Type Parameters

C

C = undefined

Parameters

args

PolicyDefinitionInput<C>

Policy metadata, handler, optional resolver, and defaults.

Returns

PolicyDefinition<C>

A file-policy definition.

Example

const MyPolicy = makePolicyDefinition({
  name: "MyPolicy",
  description: "Ensures files follow conventions",
  match: /\.ts$/,
  handler: async ({ file }) => true,
});