-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.html
439 lines (419 loc) · 28.8 KB
/
index.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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<!DOCTYPE html>
<html>
<head>
<title>Deno Cheat Sheet</title>
<link rel="stylesheet" type="text/css" href="deno-cs.css">
</head>
<body>
<nav>
<a href="https://droces.github.io/Deno-Cheat-Sheet/"
aria-selected="true">Deno</a>
<a href="https://droces.github.io/TypeScript-Cheat-Sheet/">TypeScript</a>
<a href="https://cheats.rs/">Rust</a>
</nav>
<header>
<img alt="Deno logo" src="Deno_logo.svg">
<h1>Deno Cheat Sheet</h1>
<p style="margin-top: 0;"><small>For <a href="https://deno.land">Deno</a> <span>v1.0.0</span></small></p>
</header>
<main>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">Subcommands</th></tr>
</thead>
<tbody>
<tr><td>bundle</td> <td>Bundle module and dependencies into single file</td></tr>
<tr><td>cache</td> <td>Cache the dependencies</td></tr>
<tr><td>completions</td> <td>Generate shell completions</td></tr>
<tr><td>doc</td> <td>Show documentation for a module</td></tr>
<tr><td>eval</td> <td>Eval script</td></tr>
<tr><td>fmt</td> <td>Format source files</td></tr>
<tr><td>help</td> <td>Prints this message or the help of the given subcommand(s)</td></tr>
<tr><td>info</td> <td>Show info about cache or info related to source file</td></tr>
<tr><td>install</td> <td>Install script as an executable</td></tr>
<tr><td>repl</td> <td>Read Eval Print Loop</td></tr>
<tr><td>run</td> <td>Run a program given a filename or url to the module</td></tr>
<tr><td>test</td> <td>Run tests</td></tr>
<tr><td>types</td> <td>Print runtime TypeScript declarations</td></tr>
<tr><td>upgrade</td> <td>Upgrade deno executable to given version</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="3">Run options</th></tr>
</thead>
<tbody>
<tr><th colspan="3">Permissions</th></tr>
<tr><td>-A</td><td>--allow-all</td> <td>Allow all permissions</td></tr>
<tr><td> </td><td>--allow-env</td> <td>Allow environment access</td></tr>
<tr><td> </td><td>--allow-hrtime</td> <td>Allow high resolution time measurement</td></tr>
<tr><td> </td><td>--allow-net=<allow-net></td> <td>Allow network access</td></tr>
<tr><td> </td><td>--allow-plugin</td> <td>Allow loading plugins</td></tr>
<tr><td> </td><td>--allow-read=<allow-read></td> <td>Allow file system read access</td></tr>
<tr><td> </td><td>--allow-run</td> <td>Allow running subprocesses</td></tr>
<tr><td> </td><td>--allow-write=<allow-write></td><td>Allow file system write access</td></tr>
<tr><th colspan="3">Other</th></tr>
<tr><td> </td><td>--cached-only</td> <td>Require that remote dependencies are already cached</td></tr>
<tr><td> </td><td>--cert <FILE></td> <td>Load certificate authority from PEM encoded file</td></tr>
<tr><td>-h</td><td>--help</td><td></td></tr>
<tr><td> </td><td>--importmap <FILE></td> <td>(UNSTABLE) Load import map file</td></tr>
<tr><td> </td><td>--inspect=<HOST:PORT></td> <td>Activate inspector on host:port (default: 127.0.0.1:9229)</td></tr>
<tr><td> </td><td>--inspect-brk=<HOST:PORT></td> <td>Activate inspector on host:port and break at start of user script</td></tr>
<tr><td> </td><td>--lock <FILE></td> <td>Check the specified lock file</td></tr>
<tr><td> </td><td>--lock-write </td> <td>Write lock file. Use with --lock.</td></tr>
<tr><td>-L</td><td>--log-level <log-level></td> <td>Set log level (debug, info)</td></tr>
<tr><td> </td><td>--no-remote</td> <td>Do not resolve remote modules</td></tr>
<tr><td>-q</td><td>--quiet </td> <td>Suppress diagnostic output</td></tr>
<tr><td>-r</td><td>--reload=<CACHE_BLACKLIST></td><td>Reload source code cache (recompile TypeScript)</td></tr>
<tr><td> </td><td>--seed <NUMBER></td> <td>Seed Math.random()</td></tr>
<tr><td> </td><td>--unstable </td> <td>Enable unstable APIs</td></tr>
<tr><td> </td><td>--v8-flags=<v8-flags></td> <td>Set V8 command line options. For help: --v8-flags=--help</td></tr>
<tr><td> </td><td>--version</td> <td>Prints the Deno version</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">Environment variables</th></tr>
</thead>
<tbody>
<tr><td>DENO_DIR</td> <td>Set deno's base directory (defaults to $HOME/.deno)</td></tr>
<tr><td>DENO_INSTALL_ROOT</td> <td>Set deno install's output directory<br>
(defaults to $HOME/.deno/bin)</td></tr>
<tr><td>NO_COLOR</td> <td>Set to disable color</td></tr>
<tr><td>HTTP_PROXY</td> <td>Proxy address for HTTP requests<br>
(module downloads, fetch)</td></tr>
<tr><td>HTTPS_PROXY</td> <td>Same but for HTTPS</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">Functions</th></tr>
</thead>
<tbody>
<tr><td>Deno.chdir</td> <td>Change the current working directory to the specified path</td></tr>
<tr><td>Deno.chmod</td> <td>Changes the permission of a specific file / directory of specified path.</td></tr>
<tr><td>Deno.chmodSync</td> <td></td></tr>
<tr><td>Deno.chown</td> <td></td></tr>
<tr><td>Deno.chownSync</td> <td></td></tr>
<tr><td>Deno.close</td> <td></td></tr>
<tr><td>Deno.connect</td> <td></td></tr>
<tr><td>Deno.connectTls</td> <td></td></tr>
<tr><td>Deno.copy</td> <td></td></tr>
<tr><td>Deno.copyFile</td> <td></td></tr>
<tr><td>Deno.copyFileSync</td> <td></td></tr>
<tr><td>Deno.create</td> <td></td></tr>
<tr><td>Deno.createSync</td> <td></td></tr>
<tr><td>Deno.cwd</td> <td></td></tr>
<tr><td>Deno.execPath</td> <td></td></tr>
<tr><td>Deno.exit</td> <td></td></tr>
<tr><td>Deno.inspect</td> <td></td></tr>
<tr><td>Deno.isatty</td> <td></td></tr>
<tr><td>Deno.iter</td> <td></td></tr>
<tr><td>Deno.iterSync</td> <td></td></tr>
<tr><td>Deno.listen</td> <td></td></tr>
<tr><td>Deno.listenTls</td> <td></td></tr>
<tr><td>Deno.lstat</td> <td></td></tr>
<tr><td>Deno.lstatSync</td> <td></td></tr>
<tr><td>Deno.makeTempDir</td> <td></td></tr>
<tr><td>Deno.makeTempDirSync</td> <td></td></tr>
<tr><td>Deno.makeTempFile</td> <td></td></tr>
<tr><td>Deno.makeTempFileSync</td> <td></td></tr>
<tr><td>Deno.metrics</td> <td></td></tr>
<tr><td>Deno.mkdir</td> <td></td></tr>
<tr><td>Deno.mkdirSync</td> <td></td></tr>
<tr><td>Deno.open</td> <td></td></tr>
<tr><td>Deno.openSync</td> <td></td></tr>
<tr><td>Deno.read</td> <td></td></tr>
<tr><td>Deno.readAll</td> <td></td></tr>
<tr><td>Deno.readAllSync</td> <td></td></tr>
<tr><td>Deno.readDir</td> <td></td></tr>
<tr><td>Deno.readDirSync</td> <td></td></tr>
<tr><td>Deno.readFile</td> <td></td></tr>
<tr><td>Deno.readFileSync</td> <td></td></tr>
<tr><td>Deno.readLink</td> <td></td></tr>
<tr><td>Deno.readLinkSync</td> <td></td></tr>
<tr><td>Deno.readSync</td> <td></td></tr>
<tr><td>Deno.readTextFile</td> <td></td></tr>
<tr><td>Deno.readTextFileSync</td> <td></td></tr>
<tr><td>Deno.realPath</td> <td></td></tr>
<tr><td>Deno.realPathSync</td> <td></td></tr>
<tr><td>Deno.remove</td> <td></td></tr>
<tr><td>Deno.removeSync</td> <td></td></tr>
<tr><td>Deno.rename</td> <td></td></tr>
<tr><td>Deno.renameSync</td> <td></td></tr>
<tr><td>Deno.resources</td> <td></td></tr>
<tr><td>Deno.run</td> <td></td></tr>
<tr><td>Deno.seek</td> <td></td></tr>
<tr><td>Deno.seekSync</td> <td></td></tr>
<tr><td>Deno.stat</td> <td></td></tr>
<tr><td>Deno.statSync</td> <td></td></tr>
<tr><td>Deno.test</td> <td></td></tr>
<tr><td>Deno.test</td> <td></td></tr>
<tr><td>Deno.truncate</td> <td></td></tr>
<tr><td>Deno.truncateSync</td> <td></td></tr>
<tr><td>Deno.watchFs</td> <td></td></tr>
<tr><td>Deno.write</td> <td></td></tr>
<tr><td>Deno.writeAll</td> <td></td></tr>
<tr><td>Deno.writeAllSync</td> <td></td></tr>
<tr><td>Deno.writeFile</td> <td></td></tr>
<tr><td>Deno.writeFileSync</td> <td></td></tr>
<tr><td>Deno.writeSync</td> <td></td></tr>
<tr><td>Deno.writeTextFile</td> <td></td></tr>
<tr><td>Deno.writeTextFileSync</td> <td></td></tr>
<tr><td>addEventListener</td> <td></td></tr>
<tr><td>atob</td> <td></td></tr>
<tr><td>btoa</td> <td></td></tr>
<tr><td>clearInterval</td> <td></td></tr>
<tr><td>clearTimeout</td> <td></td></tr>
<tr><td>dispatchEvent</td> <td></td></tr>
<tr><td>fetch</td> <td></td></tr>
<tr><td>performance.now</td> <td></td></tr>
<tr><td>queueMicrotask</td> <td></td></tr>
<tr><td>removeEventListener</td> <td></td></tr>
<tr><td>setInterval</td> <td></td></tr>
<tr><td>setTimeout</p></</td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">Standard Library</th></tr>
</thead>
<tbody>
<tr><td><a href="https://deno.land/std/_util">_util</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/archive">archive</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/async">async</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/bytes">bytes</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/datetime">datetime</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/encoding">encoding</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/examples">examples</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/flags">flags</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/fmt">fmt</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/fs">fs</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/hash">hash</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/http">http</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/io">io</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/log">log</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/mime">mime</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/node">node</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/path">path</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/permissions">permissions</td><td></td></tr>
<tr><td><a href="https://deno.land/std/signal">signal</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/testing">testing</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/textproto">textproto</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/uuid">uuid</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/ws">ws</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/manual">manual</td> <td></td></tr>
<tr><td><a href="https://deno.land/std/version">version</td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/datetime">datetime</a></th></tr>
</thead>
<tbody>
<tr><td>parseDate()</td> <td>Take an input string and a format to parse the date.</td></tr>
<tr><td>parseDateTime()</td> <td>Take an input string and a format to parse the dateTime.</td></tr>
<tr><td>dayOfYear()</td> <td>Returns the number of the day in the year.</td></tr>
<tr><td>currentDayOfYear()</td> <td>Returns the number of the current day in the year.</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/encoding">encoding</a></th></tr>
</thead>
<tbody>
<tr><th colspan="2">Data types</th></tr>
<tr><td><a href="https://deno.land/std/encoding#base32" >base32</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/encoding#binary" >binary</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/encoding#csv" >csv</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/encoding#toml" >toml</a></td> <td></td></tr>
<tr><td><a href="https://deno.land/std/encoding#yaml" >yaml</a></td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="3">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/http">http</a></th></tr>
</thead>
<tbody>
<tr><td>{serve}</td> <td>from "…/server.ts"</td><td></td></tr>
<tr><td>{ServerRequest}</td> <td>from "…/server.ts"</td><td></td></tr>
<tr><td>{Response}</td> <td>from "…/server.ts"</td><td></td></tr>
<tr><td>{Headers}</td> <td>from ""</td><td></td></tr>
<tr><td>{Cookie}</td> <td>from "…/cookie.ts"</td><td></td></tr>
<tr><td>{getCookies}</td> <td>from "…/cookie.ts"</td><td></td></tr>
<tr><td>{setCookie}</td> <td>from "…/cookie.ts"</td><td></td></tr>
<tr><td>{delCookie}</td> <td>from "…/cookie.ts"</td><td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/fs" title="File System">fs</a></th></tr>
</thead>
<tbody>
<tr><td>emptyDir()</td> <td>Ensures that a directory is empty</td></tr>
<tr><td>emptyDirSync()</td> <td></td></tr>
<tr><td>ensureDir()</td> <td>Ensures that the directory exists</td></tr>
<tr><td>ensureDirSync()</td> <td></td></tr>
<tr><td>ensureFile()</td> <td>Ensures that the file exists</td></tr>
<tr><td>ensureFileSync()</td> <td></td></tr>
<tr><td>ensureSymlink()</td> <td>Ensures that the link exists</td></tr>
<tr><td>ensureSymlinkSync()</td> <td></td></tr>
<tr><td>format()</td> <td></td></tr>
<tr><td>detect()</td> <td></td></tr>
<tr><td>EOL</td> <td>Detects and format the passed string for the targeted End Of Line character</td></tr>
<tr><td>exists()</td> <td>Test whether or not the given path exists by checking with the file system</td></tr>
<tr><td>existsSync()</td> <td></td></tr>
<tr><td>move()</td> <td>Moves a file or directory</td></tr>
<tr><td>moveSync()</td> <td></td></tr>
<tr><td>copy()</td> <td>Copy a file or directory</td></tr>
<tr><td>copySync()</td> <td></td></tr>
<tr><td>readJson()</td> <td>Reads a JSON file and then parses it into an object</td></tr>
<tr><td>readJsonSync()</td> <td></td></tr>
<tr><td>writeJson()</td> <td>Writes an object to a JSON file</td></tr>
<tr><td>writeJsonSync()</td> <td></td></tr>
<tr><td>walk()</td> <td>Iterate all files in a directory recursively</td></tr>
<tr><td>walkSync()</td> <td></td></tr>
<tr><td>readFileStr()</td> <td>Read file and output it as a string</td></tr>
<tr><td>readFileStrSync()</td> <td></td></tr>
<tr><td>writeFileStr()</td> <td>Write the string to file</td></tr>
<tr><td>writeFileStrSync()</td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/log">log</a></th></tr>
</thead>
<tbody>
<tr><td>log.debug()</td> <td></td></tr>
<tr><td>log.info()</td> <td></td></tr>
<tr><td>log.warning()</td> <td></td></tr>
<tr><td>log.error()</td> <td></td></tr>
<tr><td>log.critical()</td> <td></td></tr>
<tr><td>log.setup()</td> <td></td></tr>
<tr><td>log.handlers.ConsoleHandler()</td> <td></td></tr>
<tr><td>log.handlers.FileHandler()</td> <td></td></tr>
<tr><td>log.getLogger()</td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/testing">testing</a></th></tr>
</thead>
<tbody>
<tr><td>equal()</td> <td>Deep comparison; actual and expected are compared deeply</td></tr>
<tr><td>assert()</td> <td>Expects a boolean value; throws if the value is false</td></tr>
<tr><td>assertEquals()</td> <td>Uses equal comparison; throws if actual !== expected</td></tr>
<tr><td>assertNotEquals()</td> <td>Uses equal comparison; throws if actual === expected</td></tr>
<tr><td>assertStrictEq()</td> <td>Compares actual and expected strictly</td></tr>
<tr><td>assertStrContains()</td> <td>Make assertion: actual contains expected</td></tr>
<tr><td>assertMatch()</td> <td>Make assertion: actual match RegExp expected</td></tr>
<tr><td>assertArrayContains()</td> <td>Make assertion: actual array contains the expected values</td></tr>
<tr><td>assertThrows()</td> <td>Expects passed fn to throw. If fn does not, this function does</td></tr>
<tr><td>assertThrowsAsync()</td> <td>Expects passed fn to be async and throw (or return a Promise that rejects)</td></tr>
<tr><td>unimplemented()</td> <td>Use this to stub out methods that will throw when invoked</td></tr>
<tr><td>unreachable()</td> <td>Used to assert unreachable code</td></tr>
<tr><th colspan="2">Benchmarking</th></tr>
<tr><td>bench()</td> <td>Registers a benchmark that will be run once runBenchmarks is called</td></tr>
<tr><td>runBenchmarks()</td> <td>Runs all registered benchmarks serially</td></tr>
<tr><td>runIfMain()</td> <td>Runs specified benchmarks if the enclosing script is main</td></tr>
<tr><td><accr title="interface">i</accr> BenchmarkTimer</td> <td>Provides methods for starting and stopping a benchmark clock</td></tr>
<tr><td><accr title="interface">i</accr> BenchmarkFunction</td> <td>Defines a benchmark through a named function</td></tr>
<tr><td><accr title="interface">i</accr> BenchmarkDefinition</td> <td>Defines a benchmark definition with configurable runs</td></tr>
<tr><td><accr title="interface">i</accr> BenchmarkRunOptions</td> <td>Defines runBenchmark's run constraints by matching benchmark names</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/bytes">bytes</a></th></tr>
</thead>
<tbody>
<tr><td>findIndex()</td> <td>Find first index of binary pattern from given binary array</td></tr>
<tr><td>findLastIndex()</td> <td>Find last index of binary pattern from given binary array</td></tr>
<tr><td>equal()</td> <td>Check whether given binary arrays are equal to each other</td></tr>
<tr><td>hasPrefix()</td> <td>Check whether binary array has binary prefix</td></tr>
<tr><td>hasSuffix()</td> <td>Check whether binary array has binary suffix</td></tr>
<tr><td>repeat()</td> <td>Repeat bytes of given binary array and return new one</td></tr>
<tr><td>concat()</td> <td>Concatenate two binary arrays and return new one</td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/uuid" title="Universally Unique ID">uuid</a></th></tr>
</thead>
<tbody>
<tr><td>v4.generate()</td> <td></td></tr>
<tr><td>v4.validate()</td> <td></td></tr>
</tbody>
</table>
</section>
<section>
<table cellspacing="0">
<thead>
<tr><th colspan="2">
<accr title="Part of Deno's standard library">SL</accr>
<a href="https://deno.land/std/ws" title="Web Socket">ws</a></th></tr>
</thead>
<tbody>
<tr><td>isWebSocketCloseEvent()</td> <td>Returns true if input value is a WebSocketCloseEvent, false otherwise</td></tr>
<tr><td>isWebSocketPingEvent()</td> <td>Returns true if input value is a WebSocketPingEvent, false otherwise</td></tr>
<tr><td>isWebSocketPongEvent()</td> <td>Returns true if input value is a WebSocketPongEvent, false otherwise</td></tr>
<tr><td>unmask()</td> <td>Unmask masked WebSocket payload</td></tr>
<tr><td>writeFrame()</td> <td>Write WebSocket frame to inputted writer</td></tr>
<tr><td>readFrame()</td> <td>Read WebSocket frame from inputted BufReader</td></tr>
<tr><td>createMask()</td> <td>Create mask from the client to the server with random 32bit number</td></tr>
<tr><td>acceptable</td> <td>Returns true if input headers are usable for WebSocket, otherwise false</td></tr>
<tr><td>createSecAccept()</td> <td>Create value of Sec-WebSocket-Accept header from inputted nonce</td></tr>
<tr><td>acceptWebSocket()</td> <td>Upgrade inputted TCP connection into WebSocket connection</td></tr>
<tr><td>createSecKey()</td> <td>Returns base64 encoded 16 bytes string for Sec-WebSocket-Key header</td></tr>
<tr><td>connectWebSocket()</td> <td>Connect to WebSocket endpoint url with inputted endpoint string and headers</td></tr>
</tbody>
</table>
</section>
</main>
<footer>
<p>by <span>Dane Rossenrode</span> of <a href="https://touchdreams.co.za/">Touchdreams</a></p>
</footer>
</body>
</html>
<table class="min-w-full table-fixed"><tbody class="bg-white">