deno.land / std@0.224.0 / streams / iterate_reader.ts

iterate_reader.ts
View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
import { iterateReader as _iterateReader, iterateReaderSync as _iterateReaderSync,} from "../io/iterate_reader.ts";import type { Reader, ReaderSync } from "../io/types.ts";
export type { Reader, ReaderSync };
/** * Turns a {@linkcode Reader}, `r`, into an async iterator. * * @example * ```ts * import { iterateReader } from "https://deno.land/std@$STD_VERSION/streams/iterate_reader.ts"; * * using f = await Deno.open("/etc/passwd"); * for await (const chunk of iterateReader(f)) { * console.log(chunk); * } * ``` * * Second argument can be used to tune size of a buffer. * Default size of the buffer is 32kB. * * @example * ```ts * import { iterateReader } from "https://deno.land/std@$STD_VERSION/streams/iterate_reader.ts"; * * using f = await Deno.open("/etc/passwd"); * const it = iterateReader(f, { * bufSize: 1024 * 1024 * }); * for await (const chunk of it) { * console.log(chunk); * } * ``` * * @deprecated This will be removed in 1.0.0. Import from {@link https://deno.land/std/io/iterate_reader.ts} instead. */export function iterateReader( r: Reader, options?: { bufSize?: number; },): AsyncIterableIterator<Uint8Array> { return _iterateReader(r, options);}
/** * Turns a {@linkcode ReaderSync}, `r`, into an iterator. * * ```ts * import { iterateReaderSync } from "https://deno.land/std@$STD_VERSION/streams/iterate_reader.ts"; * * using f = Deno.openSync("/etc/passwd"); * for (const chunk of iterateReaderSync(f)) { * console.log(chunk); * } * ``` * * Second argument can be used to tune size of a buffer. * Default size of the buffer is 32kB. * * ```ts * import { iterateReaderSync } from "https://deno.land/std@$STD_VERSION/streams/iterate_reader.ts";
* using f = await Deno.open("/etc/passwd"); * const iter = iterateReaderSync(f, { * bufSize: 1024 * 1024 * }); * for (const chunk of iter) { * console.log(chunk); * } * ``` * * Iterator uses an internal buffer of fixed size for efficiency; it returns * a view on that buffer on each iteration. It is therefore caller's * responsibility to copy contents of the buffer if needed; otherwise the * next iteration will overwrite contents of previously returned chunk. * * @deprecated This will be removed in 1.0.0. Import from {@link https://deno.land/std/io/iterate_reader.ts} instead. */export function iterateReaderSync( r: ReaderSync, options?: { bufSize?: number; },): IterableIterator<Uint8Array> { return _iterateReaderSync(r, options);}
std

Version Info

Tagged at
6 months ago