Class BaseDetector`Abstract`

The interface every detector (pattern-based, ML, or custom) implements.

Hierarchy (View Summary)

BaseDetector

Implements

Detector

Index

Constructors

Properties

category id name trapType

Methods

findPatterns sanitize scan

Constructors

constructor

new BaseDetector(): BaseDetector

Returns BaseDetector

Properties

`Abstract` `Readonly`category

category: TrapCategory

Which trap category this detector addresses

`Abstract` `Readonly`id

id: string

Unique identifier for this detector

`Abstract` `Readonly`name

name: string

Human-readable name

`Protected` `Abstract` `Readonly`trapType

trapType: TrapType

Methods

`Abstract`findPatterns

findPatterns(content: string): PatternMatch[]
Parameters
- content: string
Returns PatternMatch[]
- Defined in src/detectors/base.ts:40

`Abstract`sanitize

sanitize(content: string, threats: Threat[]): string
Return sanitized content with threats neutralized
Parameters
- content: string
- threats: Threat[]
Returns string
Implementation of Detector.sanitize
- Defined in src/detectors/base.ts:41

scan

scan(content: string, options?: DetectorOptions): DetectorResult
Scan content and return any threats found
Parameters
- content: string
- Optionaloptions: DetectorOptions
Returns DetectorResult
Implementation of Detector.scan
- Defined in src/detectors/base.ts:43