Interface IFileMalwareScanner

An interface for malware scanners. See the ../../docs/advanced/security.md | documentation for details on how to use this class.

interface IFileMalwareScanner {
    name: string;
    scan(
        file: string,
    ): Promise<{ result: MalwareScanResult; viruses?: string }>;
}

Implemented by

ClamAVScanner

Index

Properties

Methods

Properties

`Readonly`name

name: string

The name of the scanner, e.g. ClamAV

Methods

scan

scan(file: string): Promise<{ result: MalwareScanResult; viruses?: string }>
Scans a file for malware and returns whether it contains malware.
Parameters
- file: string
Returns Promise<{ result: MalwareScanResult; viruses?: string }>
- Defined in types.ts:2482