Class DataRetentionPolicy

Index

Constructors

Methods

set unset get purge purgeAll listPolicies cutoffDate

Constructors

constructor

new DataRetentionPolicy(): DataRetentionPolicy

Returns DataRetentionPolicy

Methods

`Static`set

set(model: any, options: RetentionPolicyOptions): void
Register a retention policy on a model. This does not start any background process — call purge() on a schedule.
Parameters
- model: any
  The model class
- options: RetentionPolicyOptions
  Retention configuration
Returns void
- Defined in compliance/data-retention.ts:96

`Static`unset

unset(model: any): void
Remove the retention policy from a model.
Parameters
- model: any
Returns void
- Defined in compliance/data-retention.ts:111

`Static`get

get(model: any): RetentionPolicyOptions | undefined
Get the registered policy for a model, or undefined.
Parameters
- model: any
Returns RetentionPolicyOptions | undefined
- Defined in compliance/data-retention.ts:118

`Static`purge

purge(model: any, prorm?: any): Promise<{ affected: number; mode: string }>
Purge expired records for a specific model.
Parameters
- model: any
  The model class
- Optionalprorm: any
  The Prorm instance (for Op support)
Returns Promise<{ affected: number; mode: string }>
Number of records deleted or anonymized
- Defined in compliance/data-retention.ts:129

`Static`purgeAll

purgeAll(prorm?: any): Promise<Map<string, { affected: number; mode: string }>>
Purge all models that have a registered retention policy.
Parameters
- Optionalprorm: any
  The Prorm instance
Returns Promise<Map<string, { affected: number; mode: string }>>
A map of model name → purge result
- Defined in compliance/data-retention.ts:182

`Static`listPolicies

listPolicies(): { modelName: string; options: RetentionPolicyOptions }[]
List all models with registered retention policies.

Returns { modelName: string; options: RetentionPolicyOptions }[]
- Defined in compliance/data-retention.ts:200

`Static`cutoffDate

cutoffDate(maxAge: RetentionDuration): Date
Calculate the cutoff date for a given retention duration. Useful for displaying "records older than X will be deleted on Y".
Parameters
- maxAge: RetentionDuration
Returns Date
- Defined in compliance/data-retention.ts:211