UNPKG

@smithy/types

Version:

[![NPM version](https://img.shields.io/npm/v/@smithy/types/latest.svg)](https://www.npmjs.com/package/@smithy/types) [![NPM downloads](https://img.shields.io/npm/dm/@smithy/types.svg)](https://www.npmjs.com/package/@smithy/types)

34 lines (33 loc) 1.26 kB
/// <reference types="node" /> import { Readable } from "stream"; import { BlobOptionalType, ReadableStreamOptionalType } from "../externals-check/browser-externals-check"; /** * @public * * This is the union representing the modeled blob type with streaming trait * in a generic format that does not relate to HTTP input or output payloads. * * Note: the non-streaming blob type is represented by Uint8Array, but because * the streaming blob type is always in the request/response paylod, it has * historically been handled with different types. * * @see https://smithy.io/2.0/spec/simple-types.html#blob * * For compatibility with its historical representation, it must contain at least * Readble (Node.js), Blob (browser), and ReadableStream (browser). * * @see StreamingPayloadInputTypes for FAQ about mixing types from multiple environments. */ export type StreamingBlobTypes = NodeJsRuntimeStreamingBlobTypes | BrowserRuntimeStreamingBlobTypes; /** * @public * * Node.js streaming blob type. */ export type NodeJsRuntimeStreamingBlobTypes = Readable; /** * @public * * Browser streaming blob types. */ export type BrowserRuntimeStreamingBlobTypes = ReadableStreamOptionalType | BlobOptionalType;