Theia API Documentation v1.66.0
    Preparing search index...

    Interface CreateReadStreamOptions

    interface CreateReadStreamOptions {
        bufferSize: number;
        errorTransformer?: ErrorTransformer;
        length?: number;
        limits?: { memory?: number; size?: number };
        position?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bufferSize errorTransformer? length? limits? position?

    Properties

    bufferSize: number

    The size of the buffer to use before sending to the stream.

    errorTransformer?: ErrorTransformer

    Allows to massage any possibly error that happens during reading.

    length?: number

    Is an integer specifying how many bytes to read from the file. By default, all bytes will be read.

    limits?: { memory?: number; size?: number }

    If provided, the size of the file will be checked against the limits.

    position?: number

    Is an integer specifying where to begin reading from in the file. If position is undefined, data will be read from the current file position.

    Settings

    Member Visibility

    On This Page

    Properties