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
|
{{alias}}( filepaths[, options], clbk )
Asynchronously reads the entire contents of each file in a file list.
If a provided an encoding, the function returns file contents as strings.
Otherwise, the function returns Buffer objects.
Each file is represented by an object with the following fields:
- file: file path
- data: file contents as either a Buffer or string
Parameters
----------
filepaths: Array<string>
Filepaths.
options: Object|string (optional)
Options. If a string, the value is the encoding.
options.encoding: string|null (optional)
Encoding. Default: null.
options.flag: string (optional)
Flag. Default: 'r'.
clbk: Function
Callback to invoke upon reading file contents.
Examples
--------
> function onRead( error, data ) {
... if ( error ) {
... console.error( error.message );
... } else {
... console.log( data );
... }
... };
> var filepaths = [ './beep/boop.txt', './foo/bar.txt' ];
> {{alias}}( filepaths, onRead );
{{alias}}.sync( filepaths[, options] )
Synchronously reads the entire contents of each file in a file list.
If a provided an encoding, the function returns file contents as strings.
Otherwise, the function returns Buffer objects.
Parameters
----------
filepaths: Array<string>
Filepaths.
options: Object|string (optional)
Options. If a string, the value is the encoding.
options.encoding: string|null (optional)
Encoding. Default: null.
options.flag: string (optional)
Flag. Default: 'r'.
Returns
-------
out: Error|Array|Array<string>
File contents.
out[ i ].file: string
File path.
out[ i ].data: Buffer|string
File contents.
Examples
--------
> var filepaths = [ './beep/boop.txt', './foo/bar.txt' ];
> var out = {{alias}}.sync( filepaths );
See Also
--------
|
