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
|
{{alias}}( file[, options], clbk )
Asynchronously reads the entire contents of a file.
If provided an encoding, the function returns a string. Otherwise, the
function returns a Buffer object.
Parameters
----------
file: string|Buffer|integer
Filename or file descriptor.
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 );
... }
... };
> {{alias}}( './beep/boop.js', onRead );
{{alias}}.sync( file[, options] )
Synchronously reads the entire contents of a file.
If provided an encoding, the function returns a string. Otherwise, the
function returns a Buffer object.
Parameters
----------
file: string|Buffer|integer
Filename or file descriptor.
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|Buffer|string
File contents.
Examples
--------
> var out = {{alias}}.sync( './beep/boop.js' );
See Also
--------
|
