iya-sts
    Preparing search index...
    Index
    • Says whether files are being scanned.

      Returns boolean

      true when scanning is on and a service is named

    • The refusal for a file on disk that may not be kept, or null.

      Parameters

      • file: string

        its path

      • size: number

        its size in bytes

      Returns Promise<Refusal>

      { status, code, error }, or null to go on

    • The refusal for a file that may not be kept, or null.

      Parameters

      • bytes: Buffer

        the file

      Returns Promise<Refusal>

      { status, code, error }, or null to go on

    • Scans some bytes. Never rejects.

      Parameters

      • bytes: Buffer

        the file

      Returns Promise<Verdict>

      { clean, found, why }

    • Scans a file on disk, read as a stream so that a dataset of gigabytes is never held in memory. Never rejects.

      Parameters

      • file: string

        its path

      • size: number

        its size in bytes, which the wait grows with

      Returns Promise<Verdict>

      { clean, found, why }

    • Whether the configured service really scans, for the console's test button: it must answer OPTIONS, and it must flag the EICAR test file, the industry's harmless stand-in for a virus. Answering is not enough. A c-icap whose engine failed to load answers 204 to everything, which is exactly what a clean file gets. Never rejects.

      Returns Promise<{ ok: boolean; why: string }>

      { ok, why }