@ptkl/sdk - v1.18.0
    Preparing search index...

    Type Alias ByteRangeResult<T>

    A single window of bytes plus the position metadata needed to request the next one.

    type ByteRangeResult<T = any> = {
        contentType?: string;
        data: T;
        end: number;
        eof: boolean;
        etag?: string;
        length: number;
        start: number;
        totalSize: number;
    }

    Type Parameters

    • T = any
    Index

    Properties

    contentType? data end eof etag? length start totalSize

    Properties

    contentType?: string
    data: T

    The bytes, in the shape requested via responseType.

    end: number

    Offset of the last byte returned, inclusive.

    eof: boolean

    True when this window ends at the last byte of the object.

    etag?: string

    Object validator. Changes if the object is replaced, so a multi-window scan can detect it.

    length: number

    Number of bytes returned. May be less than requested — see ByteRangeRequest.length.

    start: number

    Offset of the first byte returned.

    totalSize: number

    Total size of the whole object.

    Settings

    Member Visibility

    On This Page

    Properties