PromptShield logo PromptShield
PromptShield WorkspaceAPI DocsInterfaces

ScanEvent

Defined in: workspace.ts:140

A discrete event yielded during the workspace scan.

Properties

name

name: string

Defined in: workspace.ts:150

Human-friendly file name (no directories).

path

path: string

Defined in: workspace.ts:145

Normalized, workspace-relative file path. Always POSIX-style for cross-platform consistency.

progress

progress: number

Defined in: workspace.ts:162

Overall scan progress (0–100). Intended for UI / CLI progress reporting.

result

result: FileScanResult

Defined in: workspace.ts:156

Filtered scan outcome. Includes detected threats and ignore-rule metadata.

On this page