prorm API Reference
    Preparing search index...

    Class SensitiveDataDiscovery

    Index
    constructor
    scan scanAll getDiscoveredFields autoProtect registerPattern unregisterPattern getPatterns generateComplianceReport
    scan: (Model: any, options?: ScanOptions) => SensitiveField[] = scanModel

    Type Declaration

    scanAll: (prorm: any, options?: ScanOptions) => ScanResult[] = scanAllModels

    Type Declaration

    getDiscoveredFields: (Model: any) => SensitiveField[] | undefined = getDiscoveredFieldsForModel

    Type Declaration

      • (Model: any): SensitiveField[] | undefined

      • Get previously discovered fields for a model.

        Parameters

        • Model: any

        Returns SensitiveField[] | undefined

    autoProtect: (Model: any, options?: ScanOptions) => void = autoProtectModel

    Type Declaration

      • (Model: any, options?: ScanOptions): void

      • Auto-protect a model by adding encryption/masking hooks.

        Parameters

        Returns void

    registerPattern: (pattern: DiscoveryPattern) => void = registerPattern

    Type Declaration

    unregisterPattern: (patternId: string) => boolean = unregisterPattern

    Type Declaration

      • (patternId: string): boolean

      • Remove a custom discovery pattern.

        Parameters

        • patternId: string

        Returns boolean

    getPatterns: () => DiscoveryPattern[] = getPatterns

    Type Declaration

    generateComplianceReport: (
        prorm: any,
        options?: ScanOptions,
    ) => {
        summary: {
            totalModels: number;
            totalSensitiveFields: number;
            byFramework: Record<ComplianceFramework, number>;
            byType: Record<SensitiveDataType, number>;
        };
        models: ScanResult[];
    } = generateComplianceReport

    Type Declaration

      • (
            prorm: any,
            options?: ScanOptions,
        ): {
            summary: {
                totalModels: number;
                totalSensitiveFields: number;
                byFramework: Record<ComplianceFramework, number>;
                byType: Record<SensitiveDataType, number>;
            };
            models: ScanResult[];
        }

      • Generate a compliance report for discovered fields.

        Parameters

        Returns {
            summary: {
                totalModels: number;
                totalSensitiveFields: number;
                byFramework: Record<ComplianceFramework, number>;
                byType: Record<SensitiveDataType, number>;
            };
            models: ScanResult[];
        }

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties