tencent cloud

文档反馈

WritableStreamDefaultWriter

最后更新时间:2024-01-30 16:01:56
    WritableStreamDefaultWriter 用于可写流的操作。基于 Web APIs 标准 WritableStreamDefaultWriter 进行设计。
    注意:
    不支持直接构造 WritableStreamDefaultWriter 对象,使用 WritableStream.getWriter 方法得到。

    描述

    // 使用 TransformStream 构造得到 WritableStream 对象
    const { writable } = new TransformStream();
    
    // 使用 WritableStream 对象获取 writer
    const writer = writable.getWriter();

    属性

    closed

    // writer.closed
    readonly closed: Promise<void>;
    返回 Promise 对象,如果流已关闭,Promise 状态为 fulfilled,如果流发生错误或写端锁已释放,Promise 状态为 rejected

    ready

    // writer.ready
    readonly ready: Promise<void>;
    返回 Promise 对象,当流的内部队列的所需大小从负变为正时,该 Promise 状态为 fulfilled,表示它不再施加背压。

    desiredSize

    // writer.desiredSize
    readonly desiredSize: number;
    返回填充流的内部队列所需的大小。

    方法

    write

    writer.write(chunk: Chunk): Promise<void>;
    chunk 数据写入流中。
    注意:
    不允许前一个写流操作结束前,调用 write 方法发起下一个写流操作。

    参数

    参数名称
    类型
    必填
    说明
    chunk
    待写入流的 chunk 数据。

    Chunk

    从流中读取的数据 Chunk,描述如下:
    type Chunk = string | ArrayBuffer | ArrayBufferView;

    close

    writer.close(): Promise<void>;
    关闭当前流。

    abort

    writer.abort(reason?: string): Promise<string>;
    终止当前流。

    releaseLock

    writer.releaseLock(): void;
    取消与流的关联,并释放流的锁定。

    相关参考

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持