mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
4df10f6b54
* chore(streams): complete documentation * tweaks
39 lines
1.1 KiB
TypeScript
39 lines
1.1 KiB
TypeScript
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import type { Writer } from "../io/types.d.ts";
|
|
|
|
/**
|
|
* Create a {@linkcode Writer} from a {@linkcode WritableStreamDefaultWriter}.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { copy } from "https://deno.land/std@$STD_VERSION/streams/copy.ts";
|
|
* import { writerFromStreamWriter } from "https://deno.land/std@$STD_VERSION/streams/writer_from_stream_writer.ts";
|
|
*
|
|
* const file = await Deno.open("./deno.land.html", { read: true });
|
|
*
|
|
* const writableStream = new WritableStream({
|
|
* write(chunk): void {
|
|
* console.log(chunk);
|
|
* },
|
|
* });
|
|
* const writer = writerFromStreamWriter(writableStream.getWriter());
|
|
* await copy(file, writer);
|
|
* file.close();
|
|
* ```
|
|
*
|
|
* @deprecated (will be removed after 1.0.0) Use {@linkcode WritableStreamDefaultWriter} directly.
|
|
*/
|
|
export function writerFromStreamWriter(
|
|
streamWriter: WritableStreamDefaultWriter<Uint8Array>,
|
|
): Writer {
|
|
return {
|
|
async write(p: Uint8Array): Promise<number> {
|
|
await streamWriter.ready;
|
|
await streamWriter.write(p);
|
|
return p.length;
|
|
},
|
|
};
|
|
}
|