forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNode_fs.html
119 lines (101 loc) · 7.07 KB
/
Node_fs.html
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../api_static/tomorrow-night.css">
<link rel="stylesheet" href="../api_static/style.css" type="text/css">
<script src="../api_static//highlight.pack.js"></script>
<script src="../api_static//script.js"></script>
<script>hljs.initHighlightingOnLoad();</script><meta charset="utf-8">
<link rel="previous" href="Node_child_process.html">
<link rel="next" href="Node_module.html">
<title>Node_fs</title>
</head>
<body>
<nav class="module-index"><ul><li><a href="Bs.html">Bs</a></li>
<li><a href="Bs_dyn.html">Bs_dyn</a></li>
<li><a href="Bs_dyn_lib.html">Bs_dyn_lib</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_boolean.html">Js_boolean</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_int64.html">Js_int64</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_nativeint.html">Js_nativeint</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_primitive.html">Js_primitive</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_unsafe.html">Js_unsafe</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"><a class="pre" href="Node_child_process.html" title="Node_child_process">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Node_module.html" title="Node_module">Next</a>
</div>
<h1>Module <a href="type_Node_fs.html">Node_fs</a></h1>
<pre><span class="keyword">module</span> Node_fs: <code class="code">sig</code> <a href="Node_fs.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="not-examples">
Node FS API<br>
<div class="tag"><b>See also</b> <a href="https://blogs.janestreet.com/a-and-a/">refernce documentation</a><br>
</div>
</div>
<div class="examples">
</div>
</div>
<hr width="100%">
<pre><span id="VALreaddirSync"><span class="keyword">val</span> readdirSync</span> : <code class="type">string -> string array</code></pre><div class="info ">
<div class="not-examples">
Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the `NODE_DEBUG` environment variable:<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALrenameSync"><span class="keyword">val</span> renameSync</span> : <code class="type">string -> string</code></pre><div class="type-declaration">
<pre><span id="TYPEfd"><span class="keyword">type</span> <code class="type"></code>fd</span> = private <code class="type">int</code> </pre>
</div>
<div class="type-declaration">
<pre><span id="TYPEpath"><span class="keyword">type</span> <code class="type"></code>path</span> = <code class="type">string</code> </pre>
</div>
<div class="info ">
<div class="not-examples">
The relative path to a filename can be used. Remember, however, that this path
will be relative to <code class="code">process.cwd()</code>.<br>
</div>
<div class="examples">
</div>
</div>
<pre><span class="keyword">module</span> <a href="Node_fs.Watch.html">Watch</a>: <code class="code">sig</code> <a href="Node_fs.Watch.html">..</a> <code class="code">end</code></pre>
<pre><span id="VALftruncateSync"><span class="keyword">val</span> ftruncateSync</span> : <code class="type"><a href="Node_fs.html#TYPEfd">fd</a> -> int -> unit</code></pre>
<pre><span id="VALtruncateSync"><span class="keyword">val</span> truncateSync</span> : <code class="type">string -> int -> unit</code></pre>
<pre><span id="VALchownSync"><span class="keyword">val</span> chownSync</span> : <code class="type">string -> uid:int -> gid:int -> unit</code></pre>
<pre><span id="VALfchownSync"><span class="keyword">val</span> fchownSync</span> : <code class="type"><a href="Node_fs.html#TYPEfd">fd</a> -> uid:int -> gid:int -> unit</code></pre>
<pre><span id="VALreadlinkSync"><span class="keyword">val</span> readlinkSync</span> : <code class="type">string -> string</code></pre>
<pre><span id="VALunlinkSync"><span class="keyword">val</span> unlinkSync</span> : <code class="type">string -> unit</code></pre>
<pre><span id="VALrmdirSync"><span class="keyword">val</span> rmdirSync</span> : <code class="type">string -> unit</code></pre>
<pre><span id="VALopenSync"><span class="keyword">val</span> openSync</span> : <code class="type"><a href="Node_fs.html#TYPEpath">path</a> -><br> [ `Append<br> | `Append_fail_if_exists<br> | `Append_read<br> | `Append_read_fail_if_exists<br> | `Read<br> | `Read_write<br> | `Read_write_sync<br> | `Write<br> | `Write_fail_if_exists<br> | `Write_read<br> | `Write_read_fail_if_exists ] -> unit</code></pre>
<pre><span id="VALreadFileSync"><span class="keyword">val</span> readFileSync</span> : <code class="type">string -><br> [ `ascii | `base64 | `binary | `hex | `latin1 | `ucs2 | `utf16le | `utf8 ] -><br> string</code></pre>
<pre><span id="VALreadFileAsUtf8Sync"><span class="keyword">val</span> readFileAsUtf8Sync</span> : <code class="type">string -> string</code></pre>
<pre><span id="VALexistsSync"><span class="keyword">val</span> existsSync</span> : <code class="type">string -> bool</code></pre>
<pre><span id="VALwriteFileSync"><span class="keyword">val</span> writeFileSync</span> : <code class="type">string -><br> string -><br> [ `ascii | `base64 | `binary | `hex | `latin1 | `ucs2 | `utf16le | `utf8 ] -><br> unit</code></pre>
<pre><span id="VALwriteFileAsUtf8Sync"><span class="keyword">val</span> writeFileAsUtf8Sync</span> : <code class="type">string -> string -> unit</code></pre></body></html>