Member Junction
    Preparing search index...

    Type Alias ObjectStreamResult

    The result of a FileStorageBase.GetObjectStream operation.

    Carries a Node.js Readable stream the caller pipes to an HTTP response (or any other sink) without ever buffering the full object in memory, plus the metadata an HTTP layer needs to populate Content-Type, Content-Length, and (for ranged reads) Content-Range / 206 Partial Content.

    type ObjectStreamResult = {
        ContentLength?: number;
        ContentRange?: { End: number; Start: number; Total: number };
        ContentType?: string;
        Stream: Readable;
    }
    Index

    Properties

    ContentLength? ContentRange? ContentType? Stream

    Properties

    ContentLength?: number

    Optional. For a full read, the total object size. For a ranged read, the number of bytes in the returned slice. Use to set Content-Length.

    ContentRange?: { End: number; Start: number; Total: number }

    Present only when a Range was honored. Provides the inclusive Start/End offsets actually returned and the Total object size, enough to build an HTTP Content-Range: bytes Start-End/Total header.

    ContentType?: string

    Optional MIME type of the object, when known from the provider response.

    Stream: Readable

    The readable byte stream for the (possibly ranged) object content.

    Settings

    Member Visibility

    On This Page

    Properties