Interface IMimeFilter

An interface for incrementally filtering data.

interface IMimeFilter {
    filter(
        input: Uint8Array,
        startIndex: number,
        length: number,
    ): MimeFilterResult;
    flush(
        input: Uint8Array,
        startIndex: number,
        length: number,
    ): MimeFilterResult;
    reset(): void;
}

Implemented by

Index

Methods

filter flush reset

Methods

filter

filter(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
Filter the specified input buffer.
Parameters
- input: Uint8Array
  The input buffer.
- startIndex: number
  The starting index of the input buffer.
- length: number
  The number of bytes of input to filter.
Returns MimeFilterResult
The filtered output range.
- Defined in src/io/filters/mime-filter.ts:25

flush

flush(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
Filter the specified input buffer, flushing all internally buffered data to the output.
Parameters
- input: Uint8Array
  The input buffer.
- startIndex: number
  The starting index of the input buffer.
- length: number
  The number of bytes of input to filter.
Returns MimeFilterResult
The filtered output range.
- Defined in src/io/filters/mime-filter.ts:34

reset

reset(): void
Reset the filter.

Returns void
- Defined in src/io/filters/mime-filter.ts:38

Interface IMimeFilter

Implemented by

Index

Methods

Methods

filter

Parameters

Returns MimeFilterResult

flush

Parameters

Returns MimeFilterResult

reset

Returns void

Settings

On This Page