diff --git a/api/README.md b/api/README.md index e511a2dd20..10f1fee67d 100644 --- a/api/README.md +++ b/api/README.md @@ -15,7 +15,7 @@ External docs: https://nodejs.org/api/events.html -# [application](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L14) +# [application](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L14) Provides Application level methods @@ -25,17 +25,17 @@ External docs: https://nodejs.org/api/events.html import { createWindow } from 'socket:application' ``` -## [MAX_WINDOWS](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L62) +## [MAX_WINDOWS](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L62) This is a `VariableDeclaration` named `MAX_WINDOWS` in `api/application.js`, it's exported but undocumented. -## [ApplicationWindowList](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L64) +## [ApplicationWindowList](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L64) This is a `ClassDeclaration` named `ApplicationWindowList` in `api/application.js`, it's exported but undocumented. -## [`addEventListener(type, listener, |boolean)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L191) +## [`addEventListener(type, listener, |boolean)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L191) Add an application event `type` callback `listener` with `options`. @@ -45,7 +45,7 @@ Add an application event `type` callback `listener` with `options`. | listener | function(Event \| MessageEvent \| CustomEvent \| ApplicationURLEvent): boolean | | false | | | |boolean | { once?: boolean | } options | false | | -## [`removeEventListener(type, listener)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L200) +## [`removeEventListener(type, listener)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L200) Remove an application event `type` callback `listener` with `options`. @@ -54,7 +54,7 @@ Remove an application event `type` callback `listener` with `options`. | type | string | | false | | | listener | function(Event \| MessageEvent \| CustomEvent \| ApplicationURLEvent): boolean | | false | | -## [`getCurrentWindowIndex()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L208) +## [`getCurrentWindowIndex()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L208) Returns the current window index @@ -62,7 +62,7 @@ Returns the current window index | :--- | :--- | :--- | | Not specified | number | | -## [`createWindow(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L243) +## [`createWindow(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L243) Creates a new window and returns an instance of ApplicationWindow. @@ -100,15 +100,15 @@ Creates a new window and returns an instance of ApplicationWindow. | :--- | :--- | :--- | | Not specified | Promise | | -### [`radius()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L270) +### [`radius()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L270) -### [`margin()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L275) +### [`margin()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L275) -## [`getScreenSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L363) +## [`getScreenSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L363) Returns the current screen size. @@ -116,7 +116,7 @@ Returns the current screen size. | :--- | :--- | :--- | | Not specified | Promise<{ width: number, height: number | >} | -## [`getWindows(indices)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L394) +## [`getWindows(indices)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L394) Returns the ApplicationWindow instances for the given indices or all windows if no indices are provided. @@ -128,7 +128,7 @@ Returns the ApplicationWindow instances for the given indices or all windows if | :--- | :--- | :--- | | Not specified | Promise | | -## [`getWindow(index)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L448) +## [`getWindow(index)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L448) Returns the ApplicationWindow instance for the given index @@ -140,7 +140,7 @@ Returns the ApplicationWindow instance for the given index | :--- | :--- | :--- | | Not specified | Promise | the ApplicationWindow instance or null if the window does not exist | -## [`getCurrentWindow()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L458) +## [`getCurrentWindow()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L458) Returns the ApplicationWindow instance for the current window. @@ -148,7 +148,7 @@ Returns the ApplicationWindow instance for the current window. | :--- | :--- | :--- | | Not specified | Promise | | -## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L467) +## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L467) Quits the backend process and then quits the render process, the exit code used is the final exit code to the OS. @@ -160,7 +160,7 @@ Quits the backend process and then quits the render process, the exit code used | :--- | :--- | :--- | | Not specified | Promise | | -## [`setSystemMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L564) +## [`setSystemMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L564) Set the native menu for the app. @@ -255,11 +255,11 @@ Set the native menu for the app. | :--- | :--- | :--- | | Not specified | Promise | | -## [`setTrayMenu()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L571) +## [`setTrayMenu()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L571) An alias to setSystemMenu for creating a tary menu -## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L580) +## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L580) Set the enabled state of the system menu. @@ -271,7 +271,7 @@ Set the enabled state of the system menu. | :--- | :--- | :--- | | Not specified | Promise | | -## [`isPaused()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L588) +## [`isPaused()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L588) Predicate function to determine if application is in a "paused" state. @@ -279,23 +279,23 @@ Predicate function to determine if application is in a "paused" state. | :--- | :--- | :--- | | Not specified | boolean | | -## [runtimeVersion](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L596) +## [runtimeVersion](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L596) Socket Runtime version. -## [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L602) +## [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L602) Runtime debug flag. -## [config](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L608) +## [config](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L608) Application configuration. -## [backend](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L613) +## [backend](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L613) The application's backend instance. -### [`open(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L619) +### [`open(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L619) @@ -308,7 +308,7 @@ The application's backend instance. | :--- | :--- | :--- | | Not specified | Promise | | -### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/application.js#L627) +### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/application.js#L627) @@ -320,7 +320,7 @@ The application's backend instance. -# [bluetooth](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L12) +# [bluetooth](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L12) A high-level, cross-platform API for Bluetooth Pub-Sub @@ -330,11 +330,11 @@ The application's backend instance. import { Bluetooth } from 'socket:bluetooth' ``` -## [`Bluetooth` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L32) +## [`Bluetooth` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L32) Create an instance of a Bluetooth service. -### [`constructor(serviceId)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L40) +### [`constructor(serviceId)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L40) constructor is an example property that is set to `true` Creates a new service with key-value pairs @@ -343,7 +343,7 @@ constructor is an example property that is set to `true` | :--- | :--- | :---: | :---: | :--- | | serviceId | string | | false | Given a default value to determine the type | -### [`start()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L90) +### [`start()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L90) Start the Bluetooth service. @@ -351,7 +351,7 @@ Start the Bluetooth service. | :--- | :--- | :--- | | Not specified | Promise | | -### [`subscribe(id)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L119) +### [`subscribe(id)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L119) Start scanning for published values that correspond to a well-known UUID. Once subscribed to a UUID, events that correspond to that UUID will be @@ -374,7 +374,7 @@ Start scanning for published values that correspond to a well-known UUID. | :--- | :--- | :--- | | Not specified | Promise | | -### [`publish(id, value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/bluetooth.js#L142) +### [`publish(id, value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/bluetooth.js#L142) Start advertising a new value for a well-known UUID @@ -391,7 +391,7 @@ Start advertising a new value for a well-known UUID -# [crypto](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L15) +# [crypto](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L15) Some high-level methods around the `crypto.subtle` API for getting @@ -402,16 +402,16 @@ Start advertising a new value for a well-known UUID import { randomBytes } from 'socket:crypto' ``` -## [webcrypto](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L30) +## [webcrypto](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L30) External docs: https://developer.mozilla.org/en-US/docs/Web/API/Crypto WebCrypto API -## [ready](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L59) +## [ready](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L59) A promise that resolves when all internals to be loaded/ready. -## [`getRandomValues(buffer)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L74) +## [`getRandomValues(buffer)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L74) External docs: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues Generate cryptographically strong random values into the `buffer` @@ -424,7 +424,7 @@ Generate cryptographically strong random values into the `buffer` | :--- | :--- | :--- | | Not specified | TypedArray | | -## [`rand64()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L97) +## [`rand64()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L97) Generate a random 64-bit number. @@ -432,19 +432,19 @@ Generate a random 64-bit number. | :--- | :--- | :--- | | A random 64-bit number. | BigInt | | -## [RANDOM_BYTES_QUOTA](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L105) +## [RANDOM_BYTES_QUOTA](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L105) Maximum total size of random bytes per page -## [MAX_RANDOM_BYTES](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L110) +## [MAX_RANDOM_BYTES](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L110) Maximum total size for random bytes. -## [MAX_RANDOM_BYTES_PAGES](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L115) +## [MAX_RANDOM_BYTES_PAGES](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L115) Maximum total amount of allocated per page of bytes (max/quota) -## [`randomBytes(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L123) +## [`randomBytes(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L123) Generate `size` random bytes. @@ -456,7 +456,7 @@ Generate `size` random bytes. | :--- | :--- | :--- | | Not specified | Buffer | A promise that resolves with an instance of socket.Buffer with random bytes. | -## [`createDigest(algorithm, message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L150) +## [`createDigest(algorithm, message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L150) @@ -469,7 +469,7 @@ Generate `size` random bytes. | :--- | :--- | :--- | | Not specified | Promise | A promise that resolves with an instance of socket.Buffer with the hash. | -## [`murmur3(value, seed)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/crypto.js#L161) +## [`murmur3(value, seed)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/crypto.js#L161) A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c that works on strings and `ArrayBuffer` views (typed arrays) @@ -487,7 +487,7 @@ A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c -# [dgram](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L13) +# [dgram](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L13) This module provides an implementation of UDP datagram sockets. It does @@ -498,7 +498,7 @@ A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c import { createSocket } from 'socket:dgram' ``` -## [`createSocket(options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L662) +## [`createSocket(options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L662) Creates a `Socket` instance. @@ -517,12 +517,12 @@ Creates a `Socket` instance. | :--- | :--- | :--- | | Not specified | Socket | | -## [`Socket` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L668) +## [`Socket` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L668) New instances of dgram.Socket are created using dgram.createSocket(). The new keyword is not to be used to create dgram.Socket instances. -### [`bind(port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L752) +### [`bind(port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L752) External docs: https://nodejs.org/api/dgram.html#socketbindport-address-callback Listen for datagram messages on a named port and optional address @@ -539,7 +539,7 @@ Listen for datagram messages on a named port and optional address | address | string | | false | The address to bind to (0.0.0.0) | | callback | function | | false | With no parameters. Called when binding is complete. | -### [`connect(port, host, connectListener)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L873) +### [`connect(port, host, connectListener)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L873) External docs: https://nodejs.org/api/dgram.html#socketconnectport-address-callback Associates the dgram.Socket to a remote address and port. Every message sent @@ -559,7 +559,7 @@ Associates the dgram.Socket to a remote address and port. Every message sent | host | string | | true | Host the client should connect to. | | connectListener | function | | true | Common parameter of socket.connect() methods. Will be added as a listener for the 'connect' event once. | -### [`disconnect()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L910) +### [`disconnect()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L910) External docs: https://nodejs.org/api/dgram.html#socketdisconnect A synchronous function that disassociates a connected dgram.Socket from @@ -567,7 +567,7 @@ A synchronous function that disassociates a connected dgram.Socket from disconnected socket will result in an ERR_SOCKET_DGRAM_NOT_CONNECTED exception. -### [`send(msg, offset, length, port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L969) +### [`send(msg, offset, length, port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L969) External docs: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback Broadcasts a datagram on the socket. For connectionless sockets, the @@ -618,7 +618,7 @@ Broadcasts a datagram on the socket. For connectionless sockets, the | address | string | | true | Destination host name or IP address. | | callback | Function | | true | Called when the message has been sent. | -### [`close(callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1067) +### [`close(callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1067) External docs: https://nodejs.org/api/dgram.html#socketclosecallback Close the underlying socket and stop listening for data on it. If a @@ -630,7 +630,7 @@ Close the underlying socket and stop listening for data on it. If a | :--- | :--- | :---: | :---: | :--- | | callback | function | | true | Called when the connection is completed or on error. | -### [`address()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1143) +### [`address()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1143) External docs: https://nodejs.org/api/dgram.html#socketaddress Returns an object containing the address information for a socket. For @@ -646,7 +646,7 @@ Returns an object containing the address information for a socket. For | socketInfo.port | string | The port of the socket | | socketInfo.family | string | The IP family of the socket | -### [`remoteAddress()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1178) +### [`remoteAddress()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1178) External docs: https://nodejs.org/api/dgram.html#socketremoteaddress Returns an object containing the address, family, and port of the remote @@ -661,7 +661,7 @@ Returns an object containing the address, family, and port of the remote | socketInfo.port | string | The port of the socket | | socketInfo.family | string | The IP family of the socket | -### [`setRecvBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1209) +### [`setRecvBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1209) External docs: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize Sets the SO_RCVBUF socket option. Sets the maximum socket receive buffer in @@ -672,7 +672,7 @@ Sets the SO_RCVBUF socket option. Sets the maximum socket receive buffer in | :--- | :--- | :---: | :---: | :--- | | size | number | | false | The size of the new receive buffer | -### [`setSendBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1226) +### [`setSendBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1226) External docs: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize Sets the SO_SNDBUF socket option. Sets the maximum socket send buffer in @@ -683,12 +683,12 @@ Sets the SO_SNDBUF socket option. Sets the maximum socket send buffer in | :--- | :--- | :---: | :---: | :--- | | size | number | | false | The size of the new send buffer | -### [`getRecvBufferSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1239) +### [`getRecvBufferSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1239) External docs: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize -### [`getSendBufferSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1247) +### [`getSendBufferSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1247) External docs: https://nodejs.org/api/dgram.html#socketgetsendbuffersize @@ -697,31 +697,31 @@ External docs: https://nodejs.org/api/dgram.html#socketgetsendbuffersize | :--- | :--- | :--- | | Not specified | number | the SO_SNDBUF socket send buffer size in bytes. | -### [`code()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1315) +### [`code()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1315) -## [`ERR_SOCKET_ALREADY_BOUND` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1321) +## [`ERR_SOCKET_ALREADY_BOUND` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1321) Thrown when a socket is already bound. -## [`ERR_SOCKET_DGRAM_IS_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1338) +## [`ERR_SOCKET_DGRAM_IS_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1338) Thrown when the socket is already connected. -## [`ERR_SOCKET_DGRAM_NOT_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1345) +## [`ERR_SOCKET_DGRAM_NOT_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1345) Thrown when the socket is not connected. -## [`ERR_SOCKET_DGRAM_NOT_RUNNING` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1353) +## [`ERR_SOCKET_DGRAM_NOT_RUNNING` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1353) Thrown when the socket is not running (not bound or connected). -## [`ERR_SOCKET_BAD_TYPE` (extends `TypeError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1360) +## [`ERR_SOCKET_BAD_TYPE` (extends `TypeError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1360) Thrown when a bad socket type is used in an argument. -## [`ERR_SOCKET_BAD_PORT` (extends `RangeError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dgram.js#L1370) +## [`ERR_SOCKET_BAD_PORT` (extends `RangeError`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dgram.js#L1370) Thrown when a bad port is given. @@ -729,7 +729,7 @@ Thrown when a bad port is given. -# [dns](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dns/index.js#L17) +# [dns](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dns/index.js#L17) This module enables name resolution. For example, use it to look up IP @@ -744,7 +744,7 @@ Thrown when a bad port is given. import { lookup } from 'socket:dns' ``` -## [`lookup(hostname, options, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dns/index.js#L60) +## [`lookup(hostname, options, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dns/index.js#L60) External docs: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback Resolves a host name (e.g. `example.org`) into the first found A (IPv4) or @@ -780,7 +780,7 @@ Resolves a host name (e.g. `example.org`) into the first found A (IPv4) or -# [dns.promises](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dns/promises.js#L17) +# [dns.promises](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dns/promises.js#L17) This module enables name resolution. For example, use it to look up IP @@ -795,7 +795,7 @@ Resolves a host name (e.g. `example.org`) into the first found A (IPv4) or import { lookup } from 'socket:dns/promises' ``` -## [`lookup(hostname, opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/dns/promises.js#L37) +## [`lookup(hostname, opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/dns/promises.js#L37) External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options @@ -814,7 +814,7 @@ External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options -# [fs](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L26) +# [fs](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L26) This module enables interacting with the file system in a way modeled on @@ -838,7 +838,7 @@ External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options import * as fs from 'socket:fs'; ``` -## [`access(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L111) +## [`access(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L111) External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Asynchronously check access a file for a given mode calling `callback` @@ -850,7 +850,7 @@ Asynchronously check access a file for a given mode calling `callback` | mode | string? \| function(Error?)? | F_OK(0) | true | | | callback | function(Error?)? | | true | | -## [`accessSync(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L143) +## [`accessSync(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L143) External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Synchronously check access a file for a given mode calling `callback` @@ -861,7 +861,7 @@ Synchronously check access a file for a given mode calling `callback` | path | string \| Buffer \| URL | | false | | | mode | string? | F_OK(0) | true | | -## [`exists(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L160) +## [`exists(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L160) Checks if a path exists @@ -870,7 +870,7 @@ Checks if a path exists | path | string \| Buffer \| URL | | false | | | callback | function(Boolean)? | | true | | -## [`existsSync(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L177) +## [`existsSync(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L177) Checks if a path exists @@ -879,7 +879,7 @@ Checks if a path exists | path | string \| Buffer \| URL | | false | | | callback | function(Boolean)? | | true | | -## [`chmod(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L197) +## [`chmod(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L197) External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback Asynchronously changes the permissions of a file. @@ -893,7 +893,7 @@ Asynchronously changes the permissions of a file. | mode | number | | false | | | callback | function(Error?) | | false | | -## [`chmodSync(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L232) +## [`chmodSync(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L232) External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback Synchronously changes the permissions of a file. @@ -904,7 +904,7 @@ Synchronously changes the permissions of a file. | path | string \| Buffer \| URL | | false | | | mode | number | | false | | -## [`chown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L256) +## [`chown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L256) Changes ownership of file or directory at `path` with `uid` and `gid`. @@ -915,7 +915,7 @@ Changes ownership of file or directory at `path` with `uid` and `gid`. | gid | number | | false | | | callback | function | | false | | -## [`chownSync(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L294) +## [`chownSync(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L294) Changes ownership of file or directory at `path` with `uid` and `gid`. @@ -925,7 +925,7 @@ Changes ownership of file or directory at `path` with `uid` and `gid`. | uid | number | | false | | | gid | number | | false | | -## [`close(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L321) +## [`close(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L321) External docs: https://nodejs.org/api/fs.html#fsclosefd-callback Asynchronously close a file descriptor calling `callback` upon success or error. @@ -935,7 +935,7 @@ Asynchronously close a file descriptor calling `callback` upon success or error. | fd | number | | false | | | callback | function(Error?)? | | true | | -## [`closeSync(fd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L341) +## [`closeSync(fd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L341) Synchronously close a file descriptor. @@ -943,7 +943,7 @@ Synchronously close a file descriptor. | :--- | :--- | :---: | :---: | :--- | | fd | number | | false | fd | -## [`copyFile(src, dest, flags, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L358) +## [`copyFile(src, dest, flags, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L358) External docs: https://nodejs.org/api/fs.html#fscopyfilesrc-dest-mode-callback Asynchronously copies `src` to `dest` calling `callback` upon success or error. @@ -955,7 +955,7 @@ Asynchronously copies `src` to `dest` calling `callback` upon success or error. | flags | number | | false | Modifiers for copy operation. | | callback | function(Error=) | | true | The function to call after completion. | -## [`copyFileSync(src, dest, flags)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L401) +## [`copyFileSync(src, dest, flags)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L401) External docs: https://nodejs.org/api/fs.html#fscopyfilesrc-dest-mode-callback Synchronously copies `src` to `dest` calling `callback` upon success or error. @@ -966,7 +966,7 @@ Synchronously copies `src` to `dest` calling `callback` upon success or error. | dest | string | | false | The destination file path. | | flags | number | | false | Modifiers for copy operation. | -## [`createReadStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L430) +## [`createReadStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L430) External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options @@ -980,7 +980,7 @@ External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options | :--- | :--- | :--- | | Not specified | ReadStream | | -## [`createWriteStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L475) +## [`createWriteStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L475) External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options @@ -994,7 +994,7 @@ External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options | :--- | :--- | :--- | | Not specified | WriteStream | | -## [`fstat(fd, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L529) +## [`fstat(fd, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L529) External docs: https://nodejs.org/api/fs.html#fsfstatfd-options-callback Invokes the callback with the for the file descriptor. See @@ -1008,7 +1008,7 @@ Invokes the callback with the for the file descriptor. See | options | object? \| function? | | true | An options object. | | callback | function? | | false | The function to call after completion. | -## [`fsync(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L556) +## [`fsync(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L556) Request that all data for the open file descriptor is flushed to the storage device. @@ -1018,7 +1018,7 @@ Request that all data for the open file descriptor is flushed | fd | number | | false | A file descriptor. | | callback | function | | false | The function to call after completion. | -## [`ftruncate(fd, offset, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L578) +## [`ftruncate(fd, offset, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L578) Truncates the file up to `offset` bytes. @@ -1028,7 +1028,7 @@ Truncates the file up to `offset` bytes. | offset | number= \| function | 0 | true | | | callback | function? | | false | The function to call after completion. | -## [`lchown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L606) +## [`lchown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L606) Chages ownership of link at `path` with `uid` and `gid. @@ -1039,7 +1039,7 @@ Chages ownership of link at `path` with `uid` and `gid. | gid | number | | false | | | callback | function | | false | | -## [`link(src, dest, )`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L645) +## [`link(src, dest, )`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L645) Creates a link to `dest` from `src`. @@ -1049,7 +1049,7 @@ Creates a link to `dest` from `src`. | dest | string | | false | | | (Position 0) | function | | false | | -## [`open(path, flags, mode, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L733) +## [`open(path, flags, mode, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L733) External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Asynchronously open a file calling `callback` upon success or error. @@ -1062,7 +1062,7 @@ Asynchronously open a file calling `callback` upon success or error. | options | object? \| function? | | true | | | callback | function(Error?, number?)? | | true | | -## [`openSync(path, flags, mode, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L786) +## [`openSync(path, flags, mode, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L786) Synchronously open a file. @@ -1073,7 +1073,7 @@ Synchronously open a file. | mode | string? | 0o666 | true | | | options | object? \| function? | | true | | -## [`opendir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L833) +## [`opendir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L833) External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Asynchronously open a directory calling `callback` upon success or error. @@ -1086,7 +1086,7 @@ Asynchronously open a directory calling `callback` upon success or error. | options.withFileTypes | boolean? | false | true | | | callback | function(Error?, Dir?)? | | false | | -## [`opendirSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L860) +## [`opendirSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L860) External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Synchronously open a directory. @@ -1102,7 +1102,7 @@ Synchronously open a directory. | :--- | :--- | :--- | | Not specified | Dir | | -## [`read(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L887) +## [`read(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L887) External docs: https://nodejs.org/api/fs.html#fsreadfd-buffer-offset-length-position-callback Asynchronously read from an open file descriptor. @@ -1116,7 +1116,7 @@ Asynchronously read from an open file descriptor. | position | number \| BigInt \| null | | false | Specifies where to begin reading from in the file. If position is null or -1 , data will be read from the current file position, and the file position will be updated. If position is an integer, the file position will be unchanged. | | callback | function(Error?, number?, Buffer?) | | false | | -## [`write(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L922) +## [`write(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L922) External docs: https://nodejs.org/api/fs.html#fswritefd-buffer-offset-length-position-callback Asynchronously write to an open file descriptor. @@ -1130,7 +1130,7 @@ Asynchronously write to an open file descriptor. | position | number \| BigInt \| null | | false | Specifies where to begin reading from in the file. If position is null or -1 , data will be read from the current file position, and the file position will be updated. If position is an integer, the file position will be unchanged. | | callback | function(Error?, number?, Buffer?) | | false | | -## [`readdir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L956) +## [`readdir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L956) External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Asynchronously read all entries in a directory. @@ -1143,7 +1143,7 @@ Asynchronously read all entries in a directory. | options.withFileTypes ? false | boolean? | | true | | | callback | function(Error?, object) | | false | | -## [`readdirSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1008) +## [`readdirSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1008) External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Synchronously read all entries in a directory. @@ -1155,7 +1155,7 @@ Synchronously read all entries in a directory. | options.encoding ? utf8 | string? | | true | | | options.withFileTypes ? false | boolean? | | true | | -## [`readFile(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1038) +## [`readFile(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1038) @@ -1168,7 +1168,7 @@ Synchronously read all entries in a directory. | options.signal | AbortSignal? | | true | | | callback | function(Error?, Buffer?) | | false | | -## [`readFileSync(path, } options, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1080) +## [`readFileSync(path, } options, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1080) @@ -1179,7 +1179,7 @@ Synchronously read all entries in a directory. | options | object? \| function(Error?, Buffer?) | | true | | | options.signal | AbortSignal? | | true | | -## [`readlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1143) +## [`readlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1143) Reads link at `path` @@ -1188,7 +1188,7 @@ Reads link at `path` | path | string | | false | | | callback | function(err, string) | | false | | -## [`realpath(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1163) +## [`realpath(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1163) Computes real path for `path` @@ -1197,7 +1197,7 @@ Computes real path for `path` | path | string | | false | | | callback | function(err, string) | | false | | -## [`realpathSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1181) +## [`realpathSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1181) Computes real path for `path` @@ -1205,7 +1205,7 @@ Computes real path for `path` | :--- | :--- | :---: | :---: | :--- | | path | string | | false | | -## [`rename(src, dest, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1199) +## [`rename(src, dest, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1199) Renames file or directory at `src` to `dest`. @@ -1215,7 +1215,7 @@ Renames file or directory at `src` to `dest`. | dest | string | | false | | | callback | function | | false | | -## [`renameSync(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1225) +## [`renameSync(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1225) Renames file or directory at `src` to `dest`, synchronously. @@ -1224,7 +1224,7 @@ Renames file or directory at `src` to `dest`, synchronously. | src | string | | false | | | dest | string | | false | | -## [`rmdir(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1249) +## [`rmdir(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1249) Removes directory at `path`. @@ -1233,7 +1233,7 @@ Removes directory at `path`. | path | string | | false | | | callback | function | | false | | -## [`rmdirSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1269) +## [`rmdirSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1269) Removes directory at `path`, synchronously. @@ -1241,7 +1241,7 @@ Removes directory at `path`, synchronously. | :--- | :--- | :---: | :---: | :--- | | path | string | | false | | -## [`statSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1290) +## [`statSync(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1290) Synchronously get the stats of a file @@ -1252,7 +1252,7 @@ Synchronously get the stats of a file | options.encoding ? utf8 | string? | | true | | | options.flag ? r | string? | | true | | -## [`stat(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1310) +## [`stat(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1310) Get the stats of a file @@ -1265,7 +1265,7 @@ Get the stats of a file | options.signal | AbortSignal? | | true | | | callback | function(Error?, Stats?) | | false | | -## [`lstat(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1382) +## [`lstat(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1382) Get the stats of a symbolic link @@ -1278,7 +1278,7 @@ Get the stats of a symbolic link | options.signal | AbortSignal? | | true | | | callback | function(Error?, Stats?) | | false | | -## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1423) +## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1423) Creates a symlink of `src` at `dest`. @@ -1287,7 +1287,7 @@ Creates a symlink of `src` at `dest`. | src | string | | false | | | dest | string | | false | | -## [`unlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1466) +## [`unlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1466) Unlinks (removes) file at `path`. @@ -1296,7 +1296,7 @@ Unlinks (removes) file at `path`. | path | string | | false | | | callback | function | | false | | -## [`unlinkSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1486) +## [`unlinkSync(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1486) Unlinks (removes) file at `path`, synchronously. @@ -1304,7 +1304,7 @@ Unlinks (removes) file at `path`, synchronously. | :--- | :--- | :---: | :---: | :--- | | path | string | | false | | -## [`writeFile(path, data, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1511) +## [`writeFile(path, data, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1511) @@ -1319,7 +1319,7 @@ Unlinks (removes) file at `path`, synchronously. | options.signal | AbortSignal? | | true | | | callback | function(Error?) | | false | | -## [`writeFileSync(path, data, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1556) +## [`writeFileSync(path, data, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1556) External docs: https://nodejs.org/api/fs.html#fswritefilesyncfile-data-options Writes data to a file synchronously. @@ -1334,7 +1334,7 @@ Writes data to a file synchronously. | options.flag ? w | string? | | true | | | options.signal | AbortSignal? | | true | | -## [`watch(, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/index.js#L1591) +## [`watch(, options, callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/index.js#L1591) Watch for changes at `path` calling `callback` @@ -1353,7 +1353,7 @@ Watch for changes at `path` calling `callback` -# [fs.promises](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L25) +# [fs.promises](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L25) * This module enables interacting with the file system in a way modeled on @@ -1377,7 +1377,7 @@ Watch for changes at `path` calling `callback` import fs from 'socket:fs/promises' ``` -## [`access(path, mode, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L111) +## [`access(path, mode, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L111) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesaccesspath-mode Asynchronously check access a file. @@ -1388,7 +1388,7 @@ Asynchronously check access a file. | mode | string? | | true | | | options | object? | | true | | -## [`chmod(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L122) +## [`chmod(path, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L122) External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode @@ -1402,7 +1402,7 @@ External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode | :--- | :--- | :--- | | Not specified | Promise | | -## [`chown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L147) +## [`chown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L147) Changes ownership of file or directory at `path` with `uid` and `gid`. @@ -1416,7 +1416,7 @@ Changes ownership of file or directory at `path` with `uid` and `gid`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`copyFile(src, dest, flags)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L176) +## [`copyFile(src, dest, flags)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L176) Asynchronously copies `src` to `dest` calling `callback` upon success or error. @@ -1430,7 +1430,7 @@ Asynchronously copies `src` to `dest` calling `callback` upon success or error. | :--- | :--- | :--- | | Not specified | Promise | | -## [`lchown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L206) +## [`lchown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L206) Chages ownership of link at `path` with `uid` and `gid. @@ -1444,7 +1444,7 @@ Chages ownership of link at `path` with `uid` and `gid. | :--- | :--- | :--- | | Not specified | Promise | | -## [`link(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L234) +## [`link(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L234) Creates a link to `dest` from `dest`. @@ -1457,7 +1457,7 @@ Creates a link to `dest` from `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`mkdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L262) +## [`mkdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L262) Asynchronously creates a directory. @@ -1473,7 +1473,7 @@ Asynchronously creates a directory. | :--- | :--- | :--- | | Not specified | Promise | Upon success, fulfills with undefined if recursive is false, or the first directory path created if recursive is true. | -## [`open(path, flags, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L292) +## [`open(path, flags, mode)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L292) External docs: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode Asynchronously open a file. @@ -1489,7 +1489,7 @@ Asynchronously open a file. | :--- | :--- | :--- | | Not specified | Promise | | -## [`opendir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L305) +## [`opendir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L305) External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options @@ -1505,7 +1505,7 @@ External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options | :--- | :--- | :--- | | Not specified | Promise | | -## [`readdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L318) +## [`readdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L318) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreaddirpath-options @@ -1517,7 +1517,7 @@ External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesr | options.encoding | string? | utf8 | true | | | options.withFileTypes | boolean? | false | true | | -## [`readFile(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L356) +## [`readFile(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L356) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreadfilepath-options @@ -1534,7 +1534,7 @@ External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesr | :--- | :--- | :--- | | Not specified | Promise | | -## [`readlink(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L374) +## [`readlink(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L374) Reads link at `path` @@ -1546,7 +1546,7 @@ Reads link at `path` | :--- | :--- | :--- | | Not specified | Promise | | -## [`realpath(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L395) +## [`realpath(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L395) Computes real path for `path` @@ -1558,7 +1558,7 @@ Computes real path for `path` | :--- | :--- | :--- | | Not specified | Promise | | -## [`rename(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L417) +## [`rename(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L417) Renames file or directory at `src` to `dest`. @@ -1571,7 +1571,7 @@ Renames file or directory at `src` to `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`rmdir(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L441) +## [`rmdir(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L441) Removes directory at `path`. @@ -1583,7 +1583,7 @@ Removes directory at `path`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`stat(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L463) +## [`stat(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L463) External docs: https://nodejs.org/api/fs.html#fspromisesstatpath-options Get the stats of a file @@ -1598,7 +1598,7 @@ Get the stats of a file | :--- | :--- | :--- | | Not specified | Promise | | -## [`lstat(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L478) +## [`lstat(path, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L478) External docs: https://nodejs.org/api/fs.html#fspromiseslstatpath-options Get the stats of a symbolic link. @@ -1613,7 +1613,7 @@ Get the stats of a symbolic link. | :--- | :--- | :--- | | Not specified | Promise | | -## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L491) +## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L491) Creates a symlink of `src` at `dest`. @@ -1626,7 +1626,7 @@ Creates a symlink of `src` at `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`unlink(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L527) +## [`unlink(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L527) Unlinks (removes) file at `path`. @@ -1638,7 +1638,7 @@ Unlinks (removes) file at `path`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`writeFile(path, data, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L552) +## [`writeFile(path, data, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L552) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromiseswritefilefile-data-options @@ -1657,7 +1657,7 @@ External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesw | :--- | :--- | :--- | | Not specified | Promise | | -## [`watch(, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/fs/promises.js#L573) +## [`watch(, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/fs/promises.js#L573) Watch for changes at `path` calling `callback` @@ -1676,7 +1676,7 @@ Watch for changes at `path` calling `callback` -# [ipc](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L37) +# [ipc](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L37) This is a low-level API that you don't need unless you are implementing @@ -1710,33 +1710,33 @@ Watch for changes at `path` calling `callback` import { send } from 'socket:ipc' ``` -## [`maybeMakeError()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L281) +## [`maybeMakeError()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L281) This is a `FunctionDeclaration` named `maybeMakeError` in `api/ipc.js`, it's exported but undocumented. -### [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L408) +### [debug](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L408) -### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L408) +### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L408) -### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L408) +### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L408) -### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L408) +### [undefined](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L408) -## [`IPCSearchParams` (extends `URLSearchParams`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1050) +## [`IPCSearchParams` (extends `URLSearchParams`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1050) This is a `ClassDeclaration` named ``IPCSearchParams` (extends `URLSearchParams`)` in `api/ipc.js`, it's exported but undocumented. -## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1218) +## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1218) Emit event to be dispatched on `window` object. @@ -1747,7 +1747,7 @@ Emit event to be dispatched on `window` object. | target | EventTarget | window | true | | | options | Object | | true | | -## [`send(command, value, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1277) +## [`send(command, value, options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1277) Sends an async IPC command request with parameters. @@ -1763,27 +1763,27 @@ Sends an async IPC command request with parameters. | :--- | :--- | :--- | | Not specified | Promise | | -## [`inflateIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1728) +## [`inflateIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1728) This is a `FunctionDeclaration` named `inflateIPCMessageTransfers` in `api/ipc.js`, it's exported but undocumented. -## [`findIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1760) +## [`findIPCMessageTransfers()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1760) This is a `FunctionDeclaration` named `findIPCMessageTransfers` in `api/ipc.js`, it's exported but undocumented. -## [ports](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1825) +## [ports](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1825) This is a `VariableDeclaration` named `ports` in `api/ipc.js`, it's exported but undocumented. -## [`IPCMessagePort` (extends `MessagePort`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L1827) +## [`IPCMessagePort` (extends `MessagePort`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L1827) This is a `ClassDeclaration` named ``IPCMessagePort` (extends `MessagePort`)` in `api/ipc.js`, it's exported but undocumented. -## [`IPCMessageChannel` (extends `MessageChannel`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/ipc.js#L2053) +## [`IPCMessageChannel` (extends `MessageChannel`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/ipc.js#L2053) This is a `ClassDeclaration` named ``IPCMessageChannel` (extends `MessageChannel`)` in `api/ipc.js`, it's exported but undocumented. @@ -1792,7 +1792,7 @@ This is a `ClassDeclaration` named ``IPCMessageChannel` (extends `MessageChannel -# [network](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/network.js#L9) +# [network](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/network.js#L9) External docs: https://socketsupply.co/guides/#p2p-guide @@ -1803,7 +1803,7 @@ External docs: https://socketsupply.co/guides/#p2p-guide -# [os](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L13) +# [os](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L13) This module provides normalized system information from all the major @@ -1814,7 +1814,7 @@ External docs: https://socketsupply.co/guides/#p2p-guide import { arch, platform } from 'socket:os' ``` -## [`arch()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L60) +## [`arch()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L60) Returns the operating system CPU architecture for which Socket was compiled. @@ -1822,7 +1822,7 @@ Returns the operating system CPU architecture for which Socket was compiled. | :--- | :--- | :--- | | Not specified | string | 'arm64', 'ia32', 'x64', or 'unknown' | -## [`cpus()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L78) +## [`cpus()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L78) External docs: https://nodejs.org/api/os.html#os_os_cpus Returns an array of objects containing information about each CPU/core. @@ -1840,7 +1840,7 @@ Returns an array of objects containing information about each CPU/core. | :--- | :--- | :--- | | cpus | Array | An array of objects containing information about each CPU/core. | -## [`networkInterfaces()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L102) +## [`networkInterfaces()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L102) External docs: https://nodejs.org/api/os.html#os_os_networkinterfaces Returns an object containing network interfaces that have been assigned a network address. @@ -1858,7 +1858,7 @@ Returns an object containing network interfaces that have been assigned a networ | :--- | :--- | :--- | | Not specified | object | An object containing network interfaces that have been assigned a network address. | -## [`platform()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L190) +## [`platform()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L190) External docs: https://nodejs.org/api/os.html#os_os_platform Returns the operating system platform. @@ -1868,7 +1868,7 @@ Returns the operating system platform. | :--- | :--- | :--- | | Not specified | string | 'android', 'cygwin', 'freebsd', 'linux', 'darwin', 'ios', 'openbsd', 'win32', or 'unknown' | -## [`type()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L199) +## [`type()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L199) External docs: https://nodejs.org/api/os.html#os_os_type Returns the operating system name. @@ -1877,7 +1877,7 @@ Returns the operating system name. | :--- | :--- | :--- | | Not specified | string | 'CYGWIN_NT', 'Mac', 'Darwin', 'FreeBSD', 'Linux', 'OpenBSD', 'Windows_NT', 'Win32', or 'Unknown' | -## [`isWindows()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L238) +## [`isWindows()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L238) @@ -1885,7 +1885,7 @@ Returns the operating system name. | :--- | :--- | :--- | | Not specified | boolean | `true` if the operating system is Windows. | -## [`tmpdir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L250) +## [`tmpdir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L250) @@ -1893,15 +1893,15 @@ Returns the operating system name. | :--- | :--- | :--- | | Not specified | string | The operating system's default directory for temporary files. | -## [EOL](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L298) +## [EOL](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L298) The operating system's end-of-line marker. `'\r\n'` on Windows and `'\n'` on POSIX. -## [`rusage()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L310) +## [`rusage()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L310) Get resource usage. -## [`uptime()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L320) +## [`uptime()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L320) Returns the system uptime in seconds. @@ -1909,7 +1909,7 @@ Returns the system uptime in seconds. | :--- | :--- | :--- | | Not specified | number | The system uptime in seconds. | -## [`uname()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L331) +## [`uname()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L331) Returns the operating system name. @@ -1917,7 +1917,7 @@ Returns the operating system name. | :--- | :--- | :--- | | Not specified | string | The operating system name. | -## [`homedir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/os.js#L389) +## [`homedir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/os.js#L389) Returns the home directory of the current user. @@ -1929,7 +1929,7 @@ Returns the home directory of the current user. -# [path](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L9) +# [path](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L9) Example usage: @@ -1937,7 +1937,7 @@ Returns the home directory of the current user. import { Path } from 'socket:path' ``` -## [`resolve()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L44) +## [`resolve()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L44) External docs: https://nodejs.org/api/path.html#path_path_resolve_paths The path.resolve() method resolves a sequence of paths or path segments into an absolute path. @@ -1950,7 +1950,7 @@ The path.resolve() method resolves a sequence of paths or path segments into an | :--- | :--- | :--- | | Not specified | string | | -## [`cwd(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L82) +## [`cwd(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L82) Computes current working directory for a path @@ -1963,7 +1963,7 @@ Computes current working directory for a path | :--- | :--- | :--- | | Not specified | string | | -## [`origin()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L106) +## [`origin()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L106) Computed location origin. Defaults to `socket:///` if not available. @@ -1971,7 +1971,7 @@ Computed location origin. Defaults to `socket:///` if not available. | :--- | :--- | :--- | | Not specified | string | | -## [`relative(options, from, to)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L117) +## [`relative(options, from, to)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L117) Computes the relative path from `from` to `to`. @@ -1985,7 +1985,7 @@ Computes the relative path from `from` to `to`. | :--- | :--- | :--- | | Not specified | string | | -## [`join(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L164) +## [`join(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L164) Joins path components. This function may not return an absolute path. @@ -1998,7 +1998,7 @@ Joins path components. This function may not return an absolute path. | :--- | :--- | :--- | | Not specified | string | | -## [`dirname(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L221) +## [`dirname(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L221) Computes directory name of path. @@ -2011,7 +2011,7 @@ Computes directory name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`basename(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L263) +## [`basename(options, components)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L263) Computes base name of path. @@ -2024,7 +2024,7 @@ Computes base name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`extname(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L277) +## [`extname(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L277) Computes extension name of path. @@ -2037,7 +2037,7 @@ Computes extension name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`normalize(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L288) +## [`normalize(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L288) Computes normalized path @@ -2050,7 +2050,7 @@ Computes normalized path | :--- | :--- | :--- | | Not specified | string | | -## [`format(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L338) +## [`format(options, path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L338) Formats `Path` object into a string. @@ -2063,7 +2063,7 @@ Formats `Path` object into a string. | :--- | :--- | :--- | | Not specified | string | | -## [`parse(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L354) +## [`parse(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L354) Parses input `path` into a `Path` instance. @@ -2075,11 +2075,11 @@ Parses input `path` into a `Path` instance. | :--- | :--- | :--- | | Not specified | object | | -## [Path](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L382) +## [Path](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L382) A container for a parsed Path. -### [`from(input, cwd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L388) +### [`from(input, cwd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L388) Creates a `Path` instance from `input` and optional `cwd`. @@ -2088,7 +2088,7 @@ Creates a `Path` instance from `input` and optional `cwd`. | input | PathComponent | | false | | | cwd | string | | true | | -### [`constructor(pathname, cwd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L411) +### [`constructor(pathname, cwd)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L411) `Path` class constructor. @@ -2097,47 +2097,47 @@ Creates a `Path` instance from `input` and optional `cwd`. | pathname | string | | false | | | cwd | string | Path.cwd() | true | | -### [`isRelative()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L484) +### [`isRelative()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L484) `true` if the path is relative, otherwise `false. -### [`value()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L491) +### [`value()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L491) The working value of this path. -### [`source()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L525) +### [`source()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L525) The original source, unresolved. -### [`parent()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L533) +### [`parent()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L533) Computed parent path. -### [`root()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L552) +### [`root()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L552) Computed root in path. -### [`dir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L573) +### [`dir()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L573) Computed directory name in path. -### [`base()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L608) +### [`base()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L608) Computed base name in path. -### [`name()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L620) +### [`name()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L620) Computed base name in path without path extension. -### [`ext()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L628) +### [`ext()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L628) Computed extension name in path. -### [`drive()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L648) +### [`drive()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L648) The computed drive, if given in the path. -### [`toURL()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L655) +### [`toURL()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L655) @@ -2145,7 +2145,7 @@ The computed drive, if given in the path. | :--- | :--- | :--- | | Not specified | URL | | -### [`toString()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/path/path.js#L663) +### [`toString()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/path/path.js#L663) Converts this `Path` instance to a string. @@ -2157,7 +2157,7 @@ Converts this `Path` instance to a string. -# [process](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L9) +# [process](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L9) Example usage: @@ -2165,22 +2165,22 @@ Converts this `Path` instance to a string. import process from 'socket:process' ``` -## [`ProcessEnvironmentEvent` (extends `Event`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L18) +## [`ProcessEnvironmentEvent` (extends `Event`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L18) This is a `ClassDeclaration` named ``ProcessEnvironmentEvent` (extends `Event`)` in `api/process.js`, it's exported but undocumented. -## [`ProcessEnvironment` (extends `EventTarget`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L29) +## [`ProcessEnvironment` (extends `EventTarget`)](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L29) This is a `ClassDeclaration` named ``ProcessEnvironment` (extends `EventTarget`)` in `api/process.js`, it's exported but undocumented. -## [env](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L35) +## [env](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L35) This is a `VariableDeclaration` named `env` in `api/process.js`, it's exported but undocumented. -## [`nextTick(callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L202) +## [`nextTick(callback)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L202) Adds callback to the 'nextTick' queue. @@ -2188,7 +2188,7 @@ Adds callback to the 'nextTick' queue. | :--- | :--- | :---: | :---: | :--- | | callback | Function | | false | | -## [`hrtime(time)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L235) +## [`hrtime(time)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L235) Computed high resolution time as a `BigInt`. @@ -2200,7 +2200,7 @@ Computed high resolution time as a `BigInt`. | :--- | :--- | :--- | | Not specified | bigint | | -## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L261) +## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L261) @@ -2208,7 +2208,7 @@ Computed high resolution time as a `BigInt`. | :--- | :--- | :---: | :---: | :--- | | code | number | 0 | true | The exit code. Default: 0. | -## [`memoryUsage()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/process.js#L273) +## [`memoryUsage()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/process.js#L273) Returns an object describing the memory usage of the Node.js process measured in bytes. @@ -2220,7 +2220,7 @@ Returns an object describing the memory usage of the Node.js process measured in -# [test](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L17) +# [test](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L17) Provides a test runner for Socket Runtime. @@ -2234,7 +2234,7 @@ Returns an object describing the memory usage of the Node.js process measured in }) ``` -## [`getDefaultTestRunnerTimeout()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L54) +## [`getDefaultTestRunnerTimeout()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L54) @@ -2242,11 +2242,11 @@ Returns an object describing the memory usage of the Node.js process measured in | :--- | :--- | :--- | | Not specified | number | The default timeout for tests in milliseconds. | -## [Test](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L69) +## [Test](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L69) -### [`constructor(name, fn, runner)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L127) +### [`constructor(name, fn, runner)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L127) @@ -2256,7 +2256,7 @@ Returns an object describing the memory usage of the Node.js process measured in | fn | TestFn | | false | | | runner | TestRunner | | false | | -### [`comment(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L138) +### [`comment(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L138) @@ -2264,7 +2264,7 @@ Returns an object describing the memory usage of the Node.js process measured in | :--- | :--- | :---: | :---: | :--- | | msg | string | | false | | -### [`plan(n)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L148) +### [`plan(n)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L148) Plan the number of assertions. @@ -2273,7 +2273,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | n | number | | false | | -### [`deepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L159) +### [`deepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L159) @@ -2283,7 +2283,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`notDeepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L174) +### [`notDeepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L174) @@ -2293,7 +2293,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`equal(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L189) +### [`equal(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L189) @@ -2303,7 +2303,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`notEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L204) +### [`notEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L204) @@ -2313,7 +2313,7 @@ Plan the number of assertions. | expected | unknown | | false | | | msg | string | | true | | -### [`fail(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L217) +### [`fail(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L217) @@ -2321,7 +2321,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | msg | string | | true | | -### [`ok(actual, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L230) +### [`ok(actual, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L230) @@ -2330,7 +2330,7 @@ Plan the number of assertions. | actual | unknown | | false | | | msg | string | | true | | -### [`pass(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L242) +### [`pass(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L242) @@ -2338,7 +2338,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | msg | string | | true | | -### [`ifError(err, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L251) +### [`ifError(err, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L251) @@ -2347,7 +2347,7 @@ Plan the number of assertions. | err | Error \| null \| undefined | | false | | | msg | string | | true | | -### [`throws(fn, expected, message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L264) +### [`throws(fn, expected, message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L264) @@ -2357,7 +2357,7 @@ Plan the number of assertions. | expected | RegExp \| any | | true | | | message | string | | true | | -### [`sleep(ms, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L313) +### [`sleep(ms, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L313) Sleep for ms with an optional msg @@ -2375,7 +2375,7 @@ Sleep for ms with an optional msg | :--- | :--- | :--- | | Not specified | Promise | | -### [`requestAnimationFrame(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L331) +### [`requestAnimationFrame(msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L331) Request animation frame with an optional msg. Falls back to a 0ms setTimeout when tests are run headlessly. @@ -2393,7 +2393,7 @@ Request animation frame with an optional msg. Falls back to a 0ms setTimeout whe | :--- | :--- | :--- | | Not specified | Promise | | -### [`click(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L354) +### [`click(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L354) Dispatch the `click`` method on an element specified by selector. @@ -2411,7 +2411,7 @@ Dispatch the `click`` method on an element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`eventClick(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L380) +### [`eventClick(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L380) Dispatch the click window.MouseEvent on an element specified by selector. @@ -2429,7 +2429,7 @@ Dispatch the click window.MouseEvent on an element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`dispatchEvent(event, target, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L408) +### [`dispatchEvent(event, target, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L408) Dispatch an event on the target. @@ -2448,7 +2448,7 @@ Dispatch an event on the target. | :--- | :--- | :--- | | Not specified | Promise | | -### [`focus(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L428) +### [`focus(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L428) Call the focus method on element specified by selector. @@ -2466,7 +2466,7 @@ Call the focus method on element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`blur(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L452) +### [`blur(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L452) Call the blur method on element specified by selector. @@ -2484,7 +2484,7 @@ Call the blur method on element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`type(selector, str, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L477) +### [`type(selector, str, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L477) Consecutively set the str value of the element specified by selector to simulate typing. @@ -2503,7 +2503,7 @@ Consecutively set the str value of the element specified by selector to simulate | :--- | :--- | :--- | | Not specified | Promise | | -### [`appendChild(parentSelector, el, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L509) +### [`appendChild(parentSelector, el, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L509) appendChild an element el to a parent selector element. @@ -2523,7 +2523,7 @@ appendChild an element el to a parent selector element. | :--- | :--- | :--- | | Not specified | Promise | | -### [`removeElement(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L529) +### [`removeElement(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L529) Remove an element from the DOM. @@ -2541,7 +2541,7 @@ Remove an element from the DOM. | :--- | :--- | :--- | | Not specified | Promise | | -### [`elementVisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L548) +### [`elementVisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L548) Test if an element is visible @@ -2559,7 +2559,7 @@ Test if an element is visible | :--- | :--- | :--- | | Not specified | Promise | | -### [`elementInvisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L569) +### [`elementInvisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L569) Test if an element is invisible @@ -2577,7 +2577,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`waitFor(querySelectorOrFn, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L593) +### [`waitFor(querySelectorOrFn, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L593) Test if an element is invisible @@ -2598,7 +2598,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`waitForText(selector, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L655) +### [`waitForText(selector, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L655) Test if an element is invisible @@ -2628,7 +2628,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`querySelector(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L692) +### [`querySelector(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L692) Run a querySelector as an assert and also get the results @@ -2646,7 +2646,7 @@ Run a querySelector as an assert and also get the results | :--- | :--- | :--- | | Not specified | HTMLElement \| Element | | -### [`querySelectorAll(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L711) +### [`querySelectorAll(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L711) Run a querySelectorAll as an assert and also get the results @@ -2664,7 +2664,7 @@ Run a querySelectorAll as an assert and also get the results | :--- | :--- | :--- | | Not specified | Array | | -### [`getComputedStyle(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L740) +### [`getComputedStyle(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L740) Retrieves the computed styles for a given element. @@ -2689,17 +2689,17 @@ Retrieves the computed styles for a given element. | :--- | :--- | :--- | | Not specified | CSSStyleDeclaration | The computed styles of the element. | -### [`run()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L837) +### [`run()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L837) pass: number, fail: number }>} -## [TestRunner](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L918) +## [TestRunner](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L918) -### [`constructor(report)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L969) +### [`constructor(report)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L969) @@ -2707,7 +2707,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :---: | :---: | :--- | | report | (lines: string) => void | | true | | -### [`nextId()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L978) +### [`nextId()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L978) @@ -2715,11 +2715,11 @@ Retrieves the computed styles for a given element. | :--- | :--- | :--- | | Not specified | string | | -### [`length()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L985) +### [`length()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L985) -### [`add(name, fn, only)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L995) +### [`add(name, fn, only)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L995) @@ -2729,7 +2729,7 @@ Retrieves the computed styles for a given element. | fn | TestFn | | false | | | only | boolean | | false | | -### [`run()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L1017) +### [`run()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L1017) @@ -2737,7 +2737,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :--- | | Not specified | Promise | | -### [`onFinish())`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L1064) +### [`onFinish())`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L1064) @@ -2745,7 +2745,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :---: | :---: | :--- | | ) | (result: { total: number, success: number, fail: number | > void} callback | false | | -## [`only(name, fn)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L1092) +## [`only(name, fn)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L1092) @@ -2754,7 +2754,7 @@ Retrieves the computed styles for a given element. | name | string | | false | | | fn | TestFn | | true | | -## [`skip(_name, _fn)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L1102) +## [`skip(_name, _fn)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L1102) @@ -2763,7 +2763,7 @@ Retrieves the computed styles for a given element. | _name | string | | false | | | _fn | TestFn | | true | | -## [`setStrict(strict)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/test/index.js#L1108) +## [`setStrict(strict)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/test/index.js#L1108) @@ -2775,7 +2775,7 @@ Retrieves the computed styles for a given element. -# [window](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L12) +# [window](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L12) Provides ApplicationWindow class and methods @@ -2784,15 +2784,15 @@ Retrieves the computed styles for a given element. `socket:application` methods like `getCurrentWindow`, `createWindow`, `getWindow`, and `getWindows`. -## [ApplicationWindow](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L35) +## [ApplicationWindow](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L35) Represents a window in the application -### [`id()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L69) +### [`id()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L69) The unique ID of this window. -### [`index()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L77) +### [`index()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L77) Get the index of the window @@ -2800,15 +2800,15 @@ Get the index of the window | :--- | :--- | :--- | | Not specified | number | the index of the window | -### [`hotkey()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L84) +### [`hotkey()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L84) -### [`channel()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L92) +### [`channel()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L92) The broadcast channel for this window. -### [`getSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L100) +### [`getSize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L100) Get the size of the window @@ -2816,7 +2816,7 @@ Get the size of the window | :--- | :--- | :--- | | Not specified | { width: number, height: number | } - the size of the window | -### [`getPosition()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L111) +### [`getPosition()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L111) Get the position of the window @@ -2824,7 +2824,7 @@ Get the position of the window | :--- | :--- | :--- | | Not specified | { x: number, y: number | } - the position of the window | -### [`getTitle()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L122) +### [`getTitle()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L122) Get the title of the window @@ -2832,7 +2832,7 @@ Get the title of the window | :--- | :--- | :--- | | Not specified | string | the title of the window | -### [`getStatus()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L130) +### [`getStatus()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L130) Get the status of the window @@ -2840,7 +2840,7 @@ Get the status of the window | :--- | :--- | :--- | | Not specified | string | the status of the window | -### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L138) +### [`close()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L138) Close the window @@ -2848,7 +2848,7 @@ Close the window | :--- | :--- | :--- | | Not specified | Promise | the options of the window | -### [`show()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L153) +### [`show()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L153) Shows the window @@ -2856,7 +2856,7 @@ Shows the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`hide()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L162) +### [`hide()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L162) Hides the window @@ -2864,7 +2864,7 @@ Hides the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`maximize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L171) +### [`maximize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L171) Maximize the window @@ -2872,7 +2872,7 @@ Maximize the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`minimize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L180) +### [`minimize()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L180) Minimize the window @@ -2880,7 +2880,7 @@ Minimize the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`restore()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L189) +### [`restore()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L189) Restore the window @@ -2888,7 +2888,7 @@ Restore the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setTitle(title)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L199) +### [`setTitle(title)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L199) Sets the title of the window @@ -2900,7 +2900,7 @@ Sets the title of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setSize(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L212) +### [`setSize(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L212) Sets the size of the window @@ -2914,7 +2914,7 @@ Sets the size of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setPosition(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L255) +### [`setPosition(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L255) Sets the position of the window @@ -2928,7 +2928,7 @@ Sets the position of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`navigate(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L299) +### [`navigate(path)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L299) Navigate the window to a given path @@ -2940,7 +2940,7 @@ Navigate the window to a given path | :--- | :--- | :--- | | Not specified | Promise | | -### [`showInspector()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L308) +### [`showInspector()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L308) Opens the Web Inspector for the window @@ -2948,7 +2948,7 @@ Opens the Web Inspector for the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setBackgroundColor(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L325) +### [`setBackgroundColor(opts)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L325) Sets the background color of the window @@ -2964,7 +2964,7 @@ Sets the background color of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`getBackgroundColor()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L334) +### [`getBackgroundColor()`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L334) Gets the background color of the window @@ -2972,7 +2972,7 @@ Gets the background color of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setContextMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L343) +### [`setContextMenu(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L343) Opens a native context menu. @@ -2984,7 +2984,7 @@ Opens a native context menu. | :--- | :--- | :--- | | Not specified | Promise | | -### [`showOpenFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L352) +### [`showOpenFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L352) Shows a native open file dialog. @@ -2996,7 +2996,7 @@ Shows a native open file dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`showSaveFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L370) +### [`showSaveFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L370) Shows a native save file dialog. @@ -3008,7 +3008,7 @@ Shows a native save file dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`showDirectoryFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L388) +### [`showDirectoryFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L388) Shows a native directory dialog. @@ -3020,7 +3020,7 @@ Shows a native directory dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`send(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L413) +### [`send(options)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L413) This is a high-level API that you should use instead of `ipc.request` when you want to send a message to another window or to the backend. @@ -3034,7 +3034,7 @@ This is a high-level API that you should use instead of `ipc.request` when | options.event | string | | false | the event to send | | options.value | string \| object | | true | the value to send | -### [`postMessage(message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L454) +### [`postMessage(message)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L454) Post a message to a window TODO(@jwerle): research using `BroadcastChannel` instead @@ -3047,7 +3047,7 @@ Post a message to a window | :--- | :--- | :--- | | Not specified | Promise | | -### [`openExternal(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L473) +### [`openExternal(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L473) Opens an URL in the default application associated with the URL protocol, such as 'https:' for the default web browser. @@ -3060,7 +3060,7 @@ Opens an URL in the default application associated with the URL protocol, | :--- | :--- | :--- | | Not specified | Promise<{ url: string | >} | -### [`revealFile(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L488) +### [`revealFile(value)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L488) Opens a file in the default file explorer. @@ -3072,7 +3072,7 @@ Opens a file in the default file explorer. | :--- | :--- | :--- | | Not specified | Promise | | -### [`addListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L503) +### [`addListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L503) Adds a listener to the window. @@ -3081,7 +3081,7 @@ Adds a listener to the window. | event | string | | false | the event to listen to | | cb | function(*): void | | false | the callback to call | -### [`on(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L521) +### [`on(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L521) Adds a listener to the window. An alias for `addListener`. @@ -3090,7 +3090,7 @@ Adds a listener to the window. An alias for `addListener`. | event | string | | false | the event to listen to | | cb | function(*): void | | false | the callback to call | -### [`once(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L538) +### [`once(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L538) Adds a listener to the window. The listener is removed after the first call. @@ -3099,7 +3099,7 @@ Adds a listener to the window. The listener is removed after the first call. | event | string | | false | the event to listen to | | cb | function(*): void | | false | the callback to call | -### [`removeListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L554) +### [`removeListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L554) Removes a listener from the window. @@ -3108,7 +3108,7 @@ Removes a listener from the window. | event | string | | false | the event to remove the listener from | | cb | function(*): void | | false | the callback to remove | -### [`removeAllListeners(event)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L567) +### [`removeAllListeners(event)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L567) Removes all listeners from the window. @@ -3116,7 +3116,7 @@ Removes all listeners from the window. | :--- | :--- | :---: | :---: | :--- | | event | string | | false | the event to remove the listeners from | -### [`off(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.6/api/window.js#L583) +### [`off(event, cb)`](https://github.com/socketsupply/socket/blob/v0.6.0-rc.8/api/window.js#L583) Removes a listener from the window. An alias for `removeListener`. diff --git a/src/desktop/main.cc b/src/desktop/main.cc index 26026c99ef..59d1b131e5 100644 --- a/src/desktop/main.cc +++ b/src/desktop/main.cc @@ -250,7 +250,7 @@ MAIN { #if SOCKET_RUNTIME_PLATFORM_LINUX // use 'SIGPWR' instead of the default 'SIGUSR1' handler // see https://github.com/WebKit/WebKit/blob/2fd8f81aac4e867ffe107c0e1b3e34b1628c0953/Source/WTF/wtf/posix/ThreadingPOSIX.cpp#L185 - Env::set("JSC_SIGNAL_FOR_GC", "30"); + // Env::set("JSC_SIGNAL_FOR_GC", "30"); gtk_init(&argc, &argv); #endif