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
|
{{alias}}( path[, flags[, mode]], clbk )
Asynchronously opens a file.
Some characters, such as <>:"/\|?*, are reserved under Windows.
Under NTFS, if the path contains a colon, Node.js will open a file system
stream.
Parameters
----------
path: string|Buffer
Filename.
flags: string|number (optional)
File system flags. Default: 'r'.
mode: integer (optional)
File mode (permission and sticky bits). This sets the file mode, but
only if the file was created. On Windows, only the write permission can
be manipulated. Default: 0o666.
clbk: Function
Callback to invoke upon opening a file.
Examples
--------
> function onOpen( error, fd ) {
... if ( error ) {
... console.error( error.message );
... } else {
... {{alias:@stdlib/fs/close}}.sync( fd );
... }
... };
> {{alias}}( './beep/boop.txt', onOpen );
{{alias}}.sync( path[, flags[, mode]] )
Synchronously opens a file.
Parameters
----------
path: string|Buffer
Filename.
flags: string|number (optional)
File system flags. Default: 'r'.
mode: integer (optional)
File mode (permission and sticky bits). This sets the file mode, but
only if the file was created. On Windows, only the write permission can
be manipulated. Default: 0o666.
Returns
-------
fd: Error|integer
File descriptor.
Examples
--------
> var fd = {{alias}}.sync( './beep/boop.txt' );
> if ( !{{alias:@stdlib/assert/is-error}}( fd ) ) { {{alias:@stdlib/fs/close}}.sync( fd ); };
See Also
--------
|
