API DocsFunctions
scan()
scan(text, options?, context?): ScanResult
Defined in: core.ts:48
Core scanning entry point.
Executes all enabled detectors in priority order:
- Trojan Source (BIDI logic manipulation)
- Invisible characters
- Homoglyph spoofing
- Unicode normalization anomalies
- Smuggling techniques
The provided context object is shared across detectors and may be
mutated for performance optimizations (e.g., caching line offsets).
Parameters
text
string
options?
ScanOptions = {}
context?
ScanContext = {}
Returns
Example
import { scan } from '@promptshield/core';
const result = scan("Hello\u200BWorld");
if (!result.isClean) {
console.log(result.threats);
}