PolicyAssessment

KIT · interface · Type contract

Result of assessing every registered policy against one input.

Import

TypeScript

import type { PolicyAssessment } from '@jangts/agent-core/kits/policies';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/policies').PolicyAssessment} PolicyAssessment */

Other public entry points:@jangts/agent-core, @jangts/agent-core/types, @jangts/agent-core/structs, @jangts/agent-core/kits/policies, @jangts/agent-core/kits.

Definition

interface PolicyAssessment<Kind>

Type parameters

Type parameter	Constraint	Default type
Kind	string	string

Field structure

Field	Type	Required	Description
required	boolean	Required	Read-only. True when at least one policy matched.
reasons	readonly string[]	Required	Read-only. Ids of the matched policies, in registration order.
kinds	readonly Kind[]	Required	Read-only. Distinct kinds of the matched policies, in first-match order.

Using the type

When using this type, choose type arguments from the table above; parameters with defaults may be omitted.