Skip to content

evaluateRetention

function evaluateRetention(options: EvaluateRetentionOptions): RetentionEvaluation;

Defined in: src/mft/retention.ts:63

Splits a listing into retained and evictable entries according to a policy.

ParameterTypeDescription
optionsEvaluateRetentionOptionsListing, policy, and optional reference clock.

RetentionEvaluation

The keep/evict split.

ConfigurationError When the policy is malformed.