From 7d409b241ff508806de544af28af2837719865cb Mon Sep 17 00:00:00 2001 From: Sergey Rubanov Date: Tue, 28 Nov 2023 18:53:27 +0100 Subject: [PATCH] Release v0.5.1 --- VERSION.txt | 2 +- api/README.md | 444 +++++++++--------- clib.json | 2 +- .../socket-darwin-arm64/package.json | 2 +- .../socket-darwin-x64/package.json | 2 +- .../socket-linux-arm64/package.json | 2 +- .../socket-linux-x64/package.json | 2 +- .../socket-win32-x64/package.json | 2 +- .../@socketsupply/socket/package.json | 12 +- 9 files changed, 235 insertions(+), 235 deletions(-) diff --git a/VERSION.txt b/VERSION.txt index 8f0916f76..4b9fcbec1 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -0.5.0 +0.5.1 diff --git a/api/README.md b/api/README.md index c5d2ad3c5..058a63ac7 100644 --- a/api/README.md +++ b/api/README.md @@ -1,7 +1,7 @@ -# [Application](https://github.com/socketsupply/socket/blob/master/api/application.js#L13) +# [Application](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L13) Provides Application level methods @@ -11,7 +11,7 @@ import { createWindow } from 'socket:application' ``` -## [`createWindow(opts)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L38) +## [`createWindow(opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L38) Creates a new window and returns an instance of ApplicationWindow. @@ -36,7 +36,7 @@ Creates a new window and returns an instance of ApplicationWindow. | :--- | :--- | :--- | | Not specified | Promise | | -## [`getScreenSize()`](https://github.com/socketsupply/socket/blob/master/api/application.js#L96) +## [`getScreenSize()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L96) Returns the current screen size. @@ -44,7 +44,7 @@ Returns the current screen size. | :--- | :--- | :--- | | Not specified | Promise<{ width: number, height: number | >} | -## [`getWindows(indices)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L122) +## [`getWindows(indices)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L122) Returns the ApplicationWindow instances for the given indices or all windows if no indices are provided. @@ -56,7 +56,7 @@ Returns the ApplicationWindow instances for the given indices or all windows if | :--- | :--- | :--- | | Not specified | Promise> | | -## [`getWindow(index)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L152) +## [`getWindow(index)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L152) Returns the ApplicationWindow instance for the given index @@ -68,7 +68,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/master/api/application.js#L162) +## [`getCurrentWindow()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L162) Returns the ApplicationWindow instance for the current window. @@ -76,7 +76,7 @@ Returns the ApplicationWindow instance for the current window. | :--- | :--- | :--- | | Not specified | Promise | | -## [`exit(code)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L171) +## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L171) Quits the backend process and then quits the render process, the exit code used is the final exit code to the OS. @@ -88,7 +88,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/master/api/application.js#L268) +## [`setSystemMenu(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L268) Set the native menu for the app. @@ -183,7 +183,7 @@ Set the native menu for the app. | :--- | :--- | :--- | | Not specified | Promise | | -## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L350) +## [`setSystemMenuItemEnabled(value)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L350) Set the enabled state of the system menu. @@ -195,23 +195,23 @@ Set the enabled state of the system menu. | :--- | :--- | :--- | | Not specified | Promise | | -## [runtimeVersion](https://github.com/socketsupply/socket/blob/master/api/application.js#L358) +## [runtimeVersion](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L358) Socket Runtime version. -## [debug](https://github.com/socketsupply/socket/blob/master/api/application.js#L364) +## [debug](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L364) Runtime debug flag. -## [config](https://github.com/socketsupply/socket/blob/master/api/application.js#L370) +## [config](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L370) Application configuration. -## [backend](https://github.com/socketsupply/socket/blob/master/api/application.js#L375) +## [backend](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L375) The application's backend instance. -### [`open(opts)`](https://github.com/socketsupply/socket/blob/master/api/application.js#L381) +### [`open(opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L381) @@ -224,7 +224,7 @@ The application's backend instance. | :--- | :--- | :--- | | Not specified | Promise | | -### [`close()`](https://github.com/socketsupply/socket/blob/master/api/application.js#L389) +### [`close()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/application.js#L389) @@ -236,7 +236,7 @@ The application's backend instance. -# [Bluetooth](https://github.com/socketsupply/socket/blob/master/api/bluetooth.js#L12) +# [Bluetooth](https://github.com/socketsupply/socket/blob/v0.5.1/api/bluetooth.js#L12) A high-level, cross-platform API for Bluetooth Pub-Sub @@ -246,11 +246,11 @@ The application's backend instance. import { Bluetooth } from 'socket:bluetooth' ``` -## [`Bluetooth` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/master/api/bluetooth.js#L32) +## [`Bluetooth` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/bluetooth.js#L32) Create an instance of a Bluetooth service. -### [`constructor(serviceId)`](https://github.com/socketsupply/socket/blob/master/api/bluetooth.js#L40) +### [`constructor(serviceId)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/bluetooth.js#L40) constructor is an example property that is set to `true` Creates a new service with key-value pairs @@ -259,7 +259,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/master/api/bluetooth.js#L90) +### [`start()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/bluetooth.js#L90) Start the Bluetooth service. @@ -267,7 +267,7 @@ Start the Bluetooth service. | :--- | :--- | :--- | | Not specified | Promise | | -### [`subscribe(id)`](https://github.com/socketsupply/socket/blob/master/api/bluetooth.js#L119) +### [`subscribe(id)`](https://github.com/socketsupply/socket/blob/v0.5.1/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 @@ -290,7 +290,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/master/api/bluetooth.js#L142) +### [`publish(id, value)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/bluetooth.js#L142) Start advertising a new value for a well-known UUID @@ -314,7 +314,7 @@ External docs: https://nodejs.org/api/buffer.html -# [Crypto](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L15) +# [Crypto](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L15) Some high-level methods around the `crypto.subtle` API for getting @@ -325,16 +325,16 @@ External docs: https://nodejs.org/api/buffer.html import { randomBytes } from 'socket:crypto' ``` -## [webcrypto](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L30) +## [webcrypto](https://github.com/socketsupply/socket/blob/v0.5.1/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/master/api/crypto.js#L59) +## [ready](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L59) A promise that resolves when all internals to be loaded/ready. -## [`getRandomValues(buffer)`](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L74) +## [`getRandomValues(buffer)`](https://github.com/socketsupply/socket/blob/v0.5.1/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` @@ -347,7 +347,7 @@ Generate cryptographically strong random values into the `buffer` | :--- | :--- | :--- | | Not specified | TypedArray | | -## [`rand64()`](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L97) +## [`rand64()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L97) Generate a random 64-bit number. @@ -355,19 +355,19 @@ Generate a random 64-bit number. | :--- | :--- | :--- | | A random 64-bit number. | BigInt | | -## [RANDOM_BYTES_QUOTA](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L105) +## [RANDOM_BYTES_QUOTA](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L105) Maximum total size of random bytes per page -## [MAX_RANDOM_BYTES](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L110) +## [MAX_RANDOM_BYTES](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L110) Maximum total size for random bytes. -## [MAX_RANDOM_BYTES_PAGES](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L115) +## [MAX_RANDOM_BYTES_PAGES](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L115) Maximum total amount of allocated per page of bytes (max/quota) -## [`randomBytes(size)`](https://github.com/socketsupply/socket/blob/master/api/crypto.js#L123) +## [`randomBytes(size)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L123) Generate `size` random bytes. @@ -379,7 +379,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/master/api/crypto.js#L150) +## [`createDigest(algorithm, message)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/crypto.js#L150) @@ -392,7 +392,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/master/api/crypto.js#L161) +## [`murmur3(value, seed)`](https://github.com/socketsupply/socket/blob/v0.5.1/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) @@ -410,7 +410,7 @@ A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c -# [DNS](https://github.com/socketsupply/socket/blob/master/api/dns/index.js#L17) +# [DNS](https://github.com/socketsupply/socket/blob/v0.5.1/api/dns/index.js#L17) This module enables name resolution. For example, use it to look up IP @@ -425,7 +425,7 @@ A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c import { lookup } from 'socket:dns' ``` -## [`lookup(hostname, options, cb)`](https://github.com/socketsupply/socket/blob/master/api/dns/index.js#L60) +## [`lookup(hostname, options, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/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 @@ -461,7 +461,7 @@ Resolves a host name (e.g. `example.org`) into the first found A (IPv4) or -# [DNS.promises](https://github.com/socketsupply/socket/blob/master/api/dns/promises.js#L17) +# [DNS.promises](https://github.com/socketsupply/socket/blob/v0.5.1/api/dns/promises.js#L17) This module enables name resolution. For example, use it to look up IP @@ -476,7 +476,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/master/api/dns/promises.js#L37) +## [`lookup(hostname, opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dns/promises.js#L37) External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options @@ -495,7 +495,7 @@ External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options -# [Dgram](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L13) +# [Dgram](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L13) This module provides an implementation of UDP datagram sockets. It does @@ -506,7 +506,7 @@ External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options import { createSocket } from 'socket:dgram' ``` -## [`createSocket(options, callback)`](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L623) +## [`createSocket(options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L623) Creates a `Socket` instance. @@ -525,12 +525,12 @@ Creates a `Socket` instance. | :--- | :--- | :--- | | Not specified | Socket | | -## [`Socket` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L629) +## [`Socket` (extends `EventEmitter`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L629) 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/master/api/dgram.js#L705) +### [`bind(port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L705) External docs: https://nodejs.org/api/dgram.html#socketbindport-address-callback Listen for datagram messages on a named port and optional address @@ -547,7 +547,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/master/api/dgram.js#L781) +### [`connect(port, host, connectListener)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L781) External docs: https://nodejs.org/api/dgram.html#socketconnectport-address-callback Associates the dgram.Socket to a remote address and port. Every message sent @@ -567,7 +567,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/master/api/dgram.js#L816) +### [`disconnect()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L816) External docs: https://nodejs.org/api/dgram.html#socketdisconnect A synchronous function that disassociates a connected dgram.Socket from @@ -575,7 +575,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/master/api/dgram.js#L875) +### [`send(msg, offset, length, port, address, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L875) External docs: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback Broadcasts a datagram on the socket. For connectionless sockets, the @@ -626,7 +626,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/master/api/dgram.js#L955) +### [`close(callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L955) External docs: https://nodejs.org/api/dgram.html#socketclosecallback Close the underlying socket and stop listening for data on it. If a @@ -638,7 +638,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/master/api/dgram.js#L1021) +### [`address()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1021) External docs: https://nodejs.org/api/dgram.html#socketaddress Returns an object containing the address information for a socket. For @@ -654,7 +654,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/master/api/dgram.js#L1056) +### [`remoteAddress()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1056) External docs: https://nodejs.org/api/dgram.html#socketremoteaddress Returns an object containing the address, family, and port of the remote @@ -669,7 +669,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/master/api/dgram.js#L1087) +### [`setRecvBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1087) External docs: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize Sets the SO_RCVBUF socket option. Sets the maximum socket receive buffer in @@ -680,7 +680,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/master/api/dgram.js#L1104) +### [`setSendBufferSize(size)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1104) External docs: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize Sets the SO_SNDBUF socket option. Sets the maximum socket send buffer in @@ -691,12 +691,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/master/api/dgram.js#L1117) +### [`getRecvBufferSize()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1117) External docs: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize -### [`getSendBufferSize()`](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1125) +### [`getSendBufferSize()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1125) External docs: https://nodejs.org/api/dgram.html#socketgetsendbuffersize @@ -705,31 +705,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/master/api/dgram.js#L1193) +### [`code()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1193) -## [`ERR_SOCKET_ALREADY_BOUND` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1199) +## [`ERR_SOCKET_ALREADY_BOUND` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1199) Thrown when a socket is already bound. -## [`ERR_SOCKET_DGRAM_IS_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1216) +## [`ERR_SOCKET_DGRAM_IS_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1216) Thrown when the socket is already connected. -## [`ERR_SOCKET_DGRAM_NOT_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1223) +## [`ERR_SOCKET_DGRAM_NOT_CONNECTED` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1223) Thrown when the socket is not connected. -## [`ERR_SOCKET_DGRAM_NOT_RUNNING` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1231) +## [`ERR_SOCKET_DGRAM_NOT_RUNNING` (extends `SocketError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1231) Thrown when the socket is not running (not bound or connected). -## [`ERR_SOCKET_BAD_TYPE` (extends `TypeError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1238) +## [`ERR_SOCKET_BAD_TYPE` (extends `TypeError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1238) Thrown when a bad socket type is used in an argument. -## [`ERR_SOCKET_BAD_PORT` (extends `RangeError`)](https://github.com/socketsupply/socket/blob/master/api/dgram.js#L1248) +## [`ERR_SOCKET_BAD_PORT` (extends `RangeError`)](https://github.com/socketsupply/socket/blob/v0.5.1/api/dgram.js#L1248) Thrown when a bad port is given. @@ -744,7 +744,7 @@ External docs: https://nodejs.org/api/events.html -# [FS](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L26) +# [FS](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L26) This module enables interacting with the file system in a way modeled on @@ -768,7 +768,7 @@ External docs: https://nodejs.org/api/events.html import * as fs from 'socket:fs'; ``` -## [`access(path, mode, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L85) +## [`access(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L85) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsopenpath-flags-mode-callback Asynchronously check access a file for a given mode calling `callback` @@ -780,7 +780,7 @@ Asynchronously check access a file for a given mode calling `callback` | mode | string? \| function(Error?)? | F_OK(0) | true | | | callback | function(Error?)? | | true | | -## [`chmod(path, mode, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L118) +## [`chmod(path, mode, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L118) External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback Asynchronously changes the permissions of a file. @@ -794,7 +794,7 @@ Asynchronously changes the permissions of a file. | mode | number | | false | | | callback | function(Error?) | | false | | -## [`chown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L143) +## [`chown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L143) Changes ownership of file or directory at `path` with `uid` and `gid`. @@ -805,7 +805,7 @@ Changes ownership of file or directory at `path` with `uid` and `gid`. | gid | number | | false | | | callback | function | | false | | -## [`close(fd, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L171) +## [`close(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L171) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsclosefd-callback Asynchronously close a file descriptor calling `callback` upon success or error. @@ -815,7 +815,7 @@ Asynchronously close a file descriptor calling `callback` upon success or error. | fd | number | | false | | | callback | function(Error?)? | | true | | -## [`copyFile(src, dest, flags, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L195) +## [`copyFile(src, dest, flags, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L195) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fscopyfilesrc-dest-mode-callback Asynchronously copies `src` to `dest` calling `callback` upon success or error. @@ -827,7 +827,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. | -## [`createReadStream(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L223) +## [`createReadStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L223) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fscreatewritestreampath-options @@ -841,7 +841,7 @@ External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fscreatewri | :--- | :--- | :--- | | Not specified | ReadStream | | -## [`createWriteStream(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L266) +## [`createWriteStream(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L266) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fscreatewritestreampath-options @@ -855,7 +855,7 @@ External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fscreatewri | :--- | :--- | :--- | | Not specified | WriteStream | | -## [`fstat(fd, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L312) +## [`fstat(fd, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L312) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsfstatfd-options-callback Invokes the callback with the for the file descriptor. See @@ -869,7 +869,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/master/api/fs/index.js#L339) +## [`fsync(fd, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L339) Request that all data for the open file descriptor is flushed to the storage device. @@ -879,7 +879,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/master/api/fs/index.js#L361) +## [`ftruncate(fd, offset, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L361) Truncates the file up to `offset` bytes. @@ -889,7 +889,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/master/api/fs/index.js#L389) +## [`lchown(path, uid, gid, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L389) Chages ownership of link at `path` with `uid` and `gid. @@ -900,7 +900,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/master/api/fs/index.js#L417) +## [`link(src, dest, )`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L417) Creates a link to `dest` from `src`. @@ -910,7 +910,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/master/api/fs/index.js#L473) +## [`open(path, flags, mode, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L473) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsopenpath-flags-mode-callback Asynchronously open a file calling `callback` upon success or error. @@ -923,7 +923,7 @@ Asynchronously open a file calling `callback` upon success or error. | options | object? \| function? | | true | | | callback | function(Error?, number?)? | | true | | -## [`opendir(path, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L526) +## [`opendir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L526) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsreaddirpath-options-callback Asynchronously open a directory calling `callback` upon success or error. @@ -936,7 +936,7 @@ Asynchronously open a directory calling `callback` upon success or error. | options.withFileTypes | boolean? | false | true | | | callback | function(Error?, Dir?)? | | false | | -## [`read(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L552) +## [`read(fd, buffer, offset, length, position, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L552) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsreadfd-buffer-offset-length-position-callback Asynchronously read from an open file descriptor. @@ -950,7 +950,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 | | -## [`readdir(path, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L586) +## [`readdir(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L586) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fsreaddirpath-options-callback Asynchronously read all entries in a directory. @@ -963,7 +963,7 @@ Asynchronously read all entries in a directory. | options.withFileTypes ? false | boolean? | | true | | | callback | function(Error?, object) | | false | | -## [`readFile(path, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L637) +## [`readFile(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L637) @@ -976,7 +976,7 @@ Asynchronously read all entries in a directory. | options.signal | AbortSignal? | | true | | | callback | function(Error?, Buffer?) | | false | | -## [`readlink(path, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L680) +## [`readlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L680) Reads link at `path` @@ -985,7 +985,7 @@ Reads link at `path` | path | string | | false | | | callback | function(err, string) | | false | | -## [`realpath(path, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L699) +## [`realpath(path, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L699) Computes real path for `path` @@ -994,7 +994,7 @@ Computes real path for `path` | path | string | | false | | | callback | function(err, string) | | false | | -## [`rename(src, dest, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L719) +## [`rename(src, dest, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L719) Renames file or directory at `src` to `dest`. @@ -1004,7 +1004,7 @@ Renames file or directory at `src` to `dest`. | dest | string | | false | | | callback | function | | false | | -## [`rmdir(path, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L742) +## [`rmdir(path, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L742) Removes directory at `path`. @@ -1013,7 +1013,7 @@ Removes directory at `path`. | path | string | | false | | | callback | function | | false | | -## [`stat(path, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L765) +## [`stat(path, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L765) @@ -1026,7 +1026,7 @@ Removes directory at `path`. | options.signal | AbortSignal? | | true | | | callback | function(Error?, Stats?) | | false | | -## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L799) +## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L799) Creates a symlink of `src` at `dest`. @@ -1035,7 +1035,7 @@ Creates a symlink of `src` at `dest`. | src | string | | false | | | dest | string | | false | | -## [`unlink(path, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L840) +## [`unlink(path, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L840) Unlinks (removes) file at `path`. @@ -1044,7 +1044,7 @@ Unlinks (removes) file at `path`. | path | string | | false | | | callback | function | | false | | -## [`writeFile(path, data, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L865) +## [`writeFile(path, data, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L865) @@ -1059,7 +1059,7 @@ Unlinks (removes) file at `path`. | options.signal | AbortSignal? | | true | | | callback | function(Error?) | | false | | -## [`watch(, options, callback)`](https://github.com/socketsupply/socket/blob/master/api/fs/index.js#L910) +## [`watch(, options, callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/index.js#L910) Watch for changes at `path` calling `callback` @@ -1078,7 +1078,7 @@ Watch for changes at `path` calling `callback` -# [FS.promises](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L25) +# [FS.promises](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L25) * This module enables interacting with the file system in a way modeled on @@ -1102,7 +1102,7 @@ Watch for changes at `path` calling `callback` import fs from 'socket:fs/promises' ``` -## [`access(path, mode, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L86) +## [`access(path, mode, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L86) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesaccesspath-mode Asynchronously check access a file. @@ -1113,7 +1113,7 @@ Asynchronously check access a file. | mode | string? | | true | | | options | object? | | true | | -## [`chmod(path, mode)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L96) +## [`chmod(path, mode)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L96) External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode @@ -1127,7 +1127,7 @@ External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode | :--- | :--- | :--- | | Not specified | Promise | | -## [`chown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L119) +## [`chown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L119) Changes ownership of file or directory at `path` with `uid` and `gid`. @@ -1141,7 +1141,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/master/api/fs/promises.js#L146) +## [`copyFile(src, dest, flags)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L146) Asynchronously copies `src` to `dest` calling `callback` upon success or error. @@ -1155,7 +1155,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/master/api/fs/promises.js#L173) +## [`lchown(path, uid, gid)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L173) Chages ownership of link at `path` with `uid` and `gid. @@ -1169,7 +1169,7 @@ Chages ownership of link at `path` with `uid` and `gid. | :--- | :--- | :--- | | Not specified | Promise | | -## [`link(src, dest)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L199) +## [`link(src, dest)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L199) Creates a link to `dest` from `dest`. @@ -1182,7 +1182,7 @@ Creates a link to `dest` from `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`mkdir(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L224) +## [`mkdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L224) Asynchronously creates a directory. @@ -1198,7 +1198,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/master/api/fs/promises.js#L252) +## [`open(path, flags, mode)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L252) External docs: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode Asynchronously open a file. @@ -1214,7 +1214,7 @@ Asynchronously open a file. | :--- | :--- | :--- | | Not specified | Promise | | -## [`opendir(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L264) +## [`opendir(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L264) External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options @@ -1230,7 +1230,7 @@ External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options | :--- | :--- | :--- | | Not specified | Promise | | -## [`readdir(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L276) +## [`readdir(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L276) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreaddirpath-options @@ -1242,7 +1242,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/master/api/fs/promises.js#L309) +## [`readFile(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L309) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreadfilepath-options @@ -1259,7 +1259,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/master/api/fs/promises.js#L326) +## [`readlink(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L326) Reads link at `path` @@ -1271,7 +1271,7 @@ Reads link at `path` | :--- | :--- | :--- | | Not specified | Promise | | -## [`realpath(path)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L345) +## [`realpath(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L345) Computes real path for `path` @@ -1283,7 +1283,7 @@ Computes real path for `path` | :--- | :--- | :--- | | Not specified | Promise | | -## [`rename(src, dest)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L365) +## [`rename(src, dest)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L365) Renames file or directory at `src` to `dest`. @@ -1296,7 +1296,7 @@ Renames file or directory at `src` to `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`rmdir(path)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L386) +## [`rmdir(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L386) Removes directory at `path`. @@ -1308,7 +1308,7 @@ Removes directory at `path`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`stat(path, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L405) +## [`stat(path, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L405) External docs: https://nodejs.org/api/fs.html#fspromisesstatpath-options @@ -1323,7 +1323,7 @@ External docs: https://nodejs.org/api/fs.html#fspromisesstatpath-options | :--- | :--- | :--- | | Not specified | Promise | | -## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L417) +## [`symlink(src, dest)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L417) Creates a symlink of `src` at `dest`. @@ -1336,7 +1336,7 @@ Creates a symlink of `src` at `dest`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`unlink(path)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L452) +## [`unlink(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L452) Unlinks (removes) file at `path`. @@ -1348,7 +1348,7 @@ Unlinks (removes) file at `path`. | :--- | :--- | :--- | | Not specified | Promise | | -## [`writeFile(path, data, options)`](https://github.com/socketsupply/socket/blob/master/api/fs/promises.js#L475) +## [`writeFile(path, data, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L475) External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromiseswritefilefile-data-options @@ -1367,7 +1367,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/master/api/fs/promises.js#L495) +## [`watch(, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/fs/promises.js#L495) Watch for changes at `path` calling `callback` @@ -1386,7 +1386,7 @@ Watch for changes at `path` calling `callback` -# [IPC](https://github.com/socketsupply/socket/blob/master/api/ipc.js#L37) +# [IPC](https://github.com/socketsupply/socket/blob/v0.5.1/api/ipc.js#L37) This is a low-level API that you don't need unless you are implementing @@ -1420,7 +1420,7 @@ Watch for changes at `path` calling `callback` import { send } from 'socket:ipc' ``` -## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/master/api/ipc.js#L1100) +## [`emit(name, value, target, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/ipc.js#L1100) Emit event to be dispatched on `window` object. @@ -1431,7 +1431,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/master/api/ipc.js#L1159) +## [`send(command, value, options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/ipc.js#L1159) Sends an async IPC command request with parameters. @@ -1451,7 +1451,7 @@ Sends an async IPC command request with parameters. -# [Network](https://github.com/socketsupply/socket/blob/master/api/network.js#L9) +# [Network](https://github.com/socketsupply/socket/blob/v0.5.1/api/network.js#L9) External docs: https://socketsupply.co/guides/#p2p-guide @@ -1462,7 +1462,7 @@ External docs: https://socketsupply.co/guides/#p2p-guide -# [OS](https://github.com/socketsupply/socket/blob/master/api/os.js#L13) +# [OS](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L13) This module provides normalized system information from all the major @@ -1473,7 +1473,7 @@ External docs: https://socketsupply.co/guides/#p2p-guide import { arch, platform } from 'socket:os' ``` -## [`arch()`](https://github.com/socketsupply/socket/blob/master/api/os.js#L56) +## [`arch()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L56) Returns the operating system CPU architecture for which Socket was compiled. @@ -1481,7 +1481,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/master/api/os.js#L74) +## [`cpus()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L74) External docs: https://nodejs.org/api/os.html#os_os_cpus Returns an array of objects containing information about each CPU/core. @@ -1499,7 +1499,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/master/api/os.js#L98) +## [`networkInterfaces()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L98) External docs: https://nodejs.org/api/os.html#os_os_networkinterfaces Returns an object containing network interfaces that have been assigned a network address. @@ -1517,7 +1517,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/master/api/os.js#L186) +## [`platform()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L186) External docs: https://nodejs.org/api/os.html#os_os_platform Returns the operating system platform. @@ -1527,7 +1527,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/master/api/os.js#L195) +## [`type()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L195) External docs: https://nodejs.org/api/os.html#os_os_type Returns the operating system name. @@ -1536,7 +1536,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/master/api/os.js#L234) +## [`isWindows()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L234) @@ -1544,7 +1544,7 @@ Returns the operating system name. | :--- | :--- | :--- | | Not specified | boolean | `true` if the operating system is Windows. | -## [`tmpdir()`](https://github.com/socketsupply/socket/blob/master/api/os.js#L246) +## [`tmpdir()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L246) @@ -1552,15 +1552,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/master/api/os.js#L294) +## [EOL](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L294) The operating system's end-of-line marker. `'\r\n'` on Windows and `'\n'` on POSIX. -## [`rusage()`](https://github.com/socketsupply/socket/blob/master/api/os.js#L306) +## [`rusage()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L306) Get resource usage. -## [`uptime()`](https://github.com/socketsupply/socket/blob/master/api/os.js#L316) +## [`uptime()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L316) Returns the system uptime in seconds. @@ -1568,7 +1568,7 @@ Returns the system uptime in seconds. | :--- | :--- | :--- | | Not specified | number | The system uptime in seconds. | -## [`uname()`](https://github.com/socketsupply/socket/blob/master/api/os.js#L327) +## [`uname()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/os.js#L327) Returns the operating system name. @@ -1580,7 +1580,7 @@ Returns the operating system name. -# [Path](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L9) +# [Path](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L9) Example usage: @@ -1588,7 +1588,7 @@ Returns the operating system name. import { Path } from 'socket:path' ``` -## [`resolve()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L41) +## [`resolve()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L41) 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. @@ -1601,7 +1601,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/master/api/path/path.js#L75) +## [`cwd(opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L75) Computes current working directory for a path @@ -1614,7 +1614,7 @@ Computes current working directory for a path | :--- | :--- | :--- | | Not specified | string | | -## [`origin()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L99) +## [`origin()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L99) Computed location origin. Defaults to `socket:///` if not available. @@ -1622,7 +1622,7 @@ Computed location origin. Defaults to `socket:///` if not available. | :--- | :--- | :--- | | Not specified | string | | -## [`relative(options, from, to)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L110) +## [`relative(options, from, to)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L110) Computes the relative path from `from` to `to`. @@ -1636,7 +1636,7 @@ Computes the relative path from `from` to `to`. | :--- | :--- | :--- | | Not specified | string | | -## [`join(options, components)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L157) +## [`join(options, components)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L157) Joins path components. This function may not return an absolute path. @@ -1649,7 +1649,7 @@ Joins path components. This function may not return an absolute path. | :--- | :--- | :--- | | Not specified | string | | -## [`dirname(options, components)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L210) +## [`dirname(options, components)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L210) Computes directory name of path. @@ -1662,7 +1662,7 @@ Computes directory name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`basename(options, components)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L246) +## [`basename(options, components)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L246) Computes base name of path. @@ -1675,7 +1675,7 @@ Computes base name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`extname(options, path)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L258) +## [`extname(options, path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L258) Computes extension name of path. @@ -1688,7 +1688,7 @@ Computes extension name of path. | :--- | :--- | :--- | | Not specified | string | | -## [`normalize(options, path)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L269) +## [`normalize(options, path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L269) Computes normalized path @@ -1701,7 +1701,7 @@ Computes normalized path | :--- | :--- | :--- | | Not specified | string | | -## [`format(options, path)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L319) +## [`format(options, path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L319) Formats `Path` object into a string. @@ -1714,7 +1714,7 @@ Formats `Path` object into a string. | :--- | :--- | :--- | | Not specified | string | | -## [`parse(path)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L335) +## [`parse(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L335) Parses input `path` into a `Path` instance. @@ -1726,11 +1726,11 @@ Parses input `path` into a `Path` instance. | :--- | :--- | :--- | | Not specified | object | | -## [Path](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L363) +## [Path](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L363) A container for a parsed Path. -### [`from(input, cwd)`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L385) +### [`from(input, cwd)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L385) Creates a `Path` instance from `input` and optional `cwd`. @@ -1739,7 +1739,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/master/api/path/path.js#L408) +### [`constructor(pathname, cwd)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L408) `Path` class constructor. @@ -1748,47 +1748,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/master/api/path/path.js#L477) +### [`isRelative()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L477) `true` if the path is relative, otherwise `false. -### [`value()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L484) +### [`value()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L484) The working value of this path. -### [`source()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L518) +### [`source()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L518) The original source, unresolved. -### [`parent()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L526) +### [`parent()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L526) Computed parent path. -### [`root()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L545) +### [`root()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L545) Computed root in path. -### [`dir()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L566) +### [`dir()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L566) Computed directory name in path. -### [`base()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L601) +### [`base()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L601) Computed base name in path. -### [`name()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L613) +### [`name()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L613) Computed base name in path without path extension. -### [`ext()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L621) +### [`ext()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L621) Computed extension name in path. -### [`drive()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L641) +### [`drive()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L641) The computed drive, if given in the path. -### [`toURL()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L648) +### [`toURL()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L648) @@ -1796,7 +1796,7 @@ The computed drive, if given in the path. | :--- | :--- | :--- | | Not specified | URL | | -### [`toString()`](https://github.com/socketsupply/socket/blob/master/api/path/path.js#L656) +### [`toString()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/path/path.js#L656) Converts this `Path` instance to a string. @@ -1808,7 +1808,7 @@ Converts this `Path` instance to a string. -# [Process](https://github.com/socketsupply/socket/blob/master/api/process.js#L9) +# [Process](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L9) Example usage: @@ -1816,7 +1816,7 @@ Converts this `Path` instance to a string. import process from 'socket:process' ``` -## [`nextTick(callback)`](https://github.com/socketsupply/socket/blob/master/api/process.js#L42) +## [`nextTick(callback)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L42) Adds callback to the 'nextTick' queue. @@ -1824,7 +1824,7 @@ Adds callback to the 'nextTick' queue. | :--- | :--- | :---: | :---: | :--- | | callback | Function | | false | | -## [`homedir()`](https://github.com/socketsupply/socket/blob/master/api/process.js#L71) +## [`homedir()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L71) @@ -1832,7 +1832,7 @@ Adds callback to the 'nextTick' queue. | :--- | :--- | :--- | | Not specified | string | The home directory of the current user. | -## [`hrtime(time)`](https://github.com/socketsupply/socket/blob/master/api/process.js#L80) +## [`hrtime(time)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L80) Computed high resolution time as a `BigInt`. @@ -1844,7 +1844,7 @@ Computed high resolution time as a `BigInt`. | :--- | :--- | :--- | | Not specified | bigint | | -## [`exit(code)`](https://github.com/socketsupply/socket/blob/master/api/process.js#L104) +## [`exit(code)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L104) @@ -1852,7 +1852,7 @@ Computed high resolution time as a `BigInt`. | :--- | :--- | :---: | :---: | :--- | | code | number | 0 | true | The exit code. Default: 0. | -## [`memoryUsage()`](https://github.com/socketsupply/socket/blob/master/api/process.js#L116) +## [`memoryUsage()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/process.js#L116) Returns an object describing the memory usage of the Node.js process measured in bytes. @@ -1864,7 +1864,7 @@ Returns an object describing the memory usage of the Node.js process measured in -# [Test](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L17) +# [Test](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L17) Provides a test runner for Socket Runtime. @@ -1878,7 +1878,7 @@ Returns an object describing the memory usage of the Node.js process measured in }) ``` -## [`getDefaultTestRunnerTimeout()`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L54) +## [`getDefaultTestRunnerTimeout()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L54) @@ -1886,11 +1886,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/master/api/test/index.js#L69) +## [Test](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L69) -### [`constructor(name, fn, runner)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L76) +### [`constructor(name, fn, runner)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L76) @@ -1900,7 +1900,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/master/api/test/index.js#L127) +### [`comment(msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L127) @@ -1908,7 +1908,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/master/api/test/index.js#L137) +### [`plan(n)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L137) Plan the number of assertions. @@ -1917,7 +1917,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | n | number | | false | | -### [`deepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L148) +### [`deepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L148) @@ -1927,7 +1927,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`notDeepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L163) +### [`notDeepEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L163) @@ -1937,7 +1937,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`equal(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L178) +### [`equal(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L178) @@ -1947,7 +1947,7 @@ Plan the number of assertions. | expected | T | | false | | | msg | string | | true | | -### [`notEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L193) +### [`notEqual(actual, expected, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L193) @@ -1957,7 +1957,7 @@ Plan the number of assertions. | expected | unknown | | false | | | msg | string | | true | | -### [`fail(msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L206) +### [`fail(msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L206) @@ -1965,7 +1965,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | msg | string | | true | | -### [`ok(actual, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L219) +### [`ok(actual, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L219) @@ -1974,7 +1974,7 @@ Plan the number of assertions. | actual | unknown | | false | | | msg | string | | true | | -### [`pass(msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L231) +### [`pass(msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L231) @@ -1982,7 +1982,7 @@ Plan the number of assertions. | :--- | :--- | :---: | :---: | :--- | | msg | string | | true | | -### [`ifError(err, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L240) +### [`ifError(err, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L240) @@ -1991,7 +1991,7 @@ Plan the number of assertions. | err | Error \| null \| undefined | | false | | | msg | string | | true | | -### [`throws(fn, expected, message)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L253) +### [`throws(fn, expected, message)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L253) @@ -2001,7 +2001,7 @@ Plan the number of assertions. | expected | RegExp \| any | | true | | | message | string | | true | | -### [`sleep(ms, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L302) +### [`sleep(ms, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L302) Sleep for ms with an optional msg @@ -2019,7 +2019,7 @@ Sleep for ms with an optional msg | :--- | :--- | :--- | | Not specified | Promise | | -### [`requestAnimationFrame(msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L320) +### [`requestAnimationFrame(msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L320) Request animation frame with an optional msg. Falls back to a 0ms setTimeout when tests are run headlessly. @@ -2037,7 +2037,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/master/api/test/index.js#L342) +### [`click(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L342) Dispatch the `click`` method on an element specified by selector. @@ -2055,7 +2055,7 @@ Dispatch the `click`` method on an element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`eventClick(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L364) +### [`eventClick(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L364) Dispatch the click window.MouseEvent on an element specified by selector. @@ -2073,7 +2073,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/master/api/test/index.js#L392) +### [`dispatchEvent(event, target, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L392) Dispatch an event on the target. @@ -2092,7 +2092,7 @@ Dispatch an event on the target. | :--- | :--- | :--- | | Not specified | Promise | | -### [`focus(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L412) +### [`focus(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L412) Call the focus method on element specified by selector. @@ -2110,7 +2110,7 @@ Call the focus method on element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`blur(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L433) +### [`blur(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L433) Call the blur method on element specified by selector. @@ -2128,7 +2128,7 @@ Call the blur method on element specified by selector. | :--- | :--- | :--- | | Not specified | Promise | | -### [`type(selector, str, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L455) +### [`type(selector, str, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L455) Consecutively set the str value of the element specified by selector to simulate typing. @@ -2147,7 +2147,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/master/api/test/index.js#L487) +### [`appendChild(parentSelector, el, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L487) appendChild an element el to a parent selector element. @@ -2167,7 +2167,7 @@ appendChild an element el to a parent selector element. | :--- | :--- | :--- | | Not specified | Promise | | -### [`removeElement(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L507) +### [`removeElement(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L507) Remove an element from the DOM. @@ -2185,7 +2185,7 @@ Remove an element from the DOM. | :--- | :--- | :--- | | Not specified | Promise | | -### [`elementVisible(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L526) +### [`elementVisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L526) Test if an element is visible @@ -2203,7 +2203,7 @@ Test if an element is visible | :--- | :--- | :--- | | Not specified | Promise | | -### [`elementInvisible(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L547) +### [`elementInvisible(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L547) Test if an element is invisible @@ -2221,7 +2221,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`waitFor(querySelectorOrFn, opts, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L571) +### [`waitFor(querySelectorOrFn, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L571) Test if an element is invisible @@ -2242,7 +2242,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`waitForText(selector, opts, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L633) +### [`waitForText(selector, opts, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L633) Test if an element is invisible @@ -2272,7 +2272,7 @@ Test if an element is invisible | :--- | :--- | :--- | | Not specified | Promise | | -### [`querySelector(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L670) +### [`querySelector(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L670) Run a querySelector as an assert and also get the results @@ -2290,7 +2290,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/master/api/test/index.js#L689) +### [`querySelectorAll(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L689) Run a querySelectorAll as an assert and also get the results @@ -2308,7 +2308,7 @@ Run a querySelectorAll as an assert and also get the results | :--- | :--- | :--- | | Not specified | Array | | -### [`getComputedStyle(selector, msg)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L718) +### [`getComputedStyle(selector, msg)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L718) Retrieves the computed styles for a given element. @@ -2333,17 +2333,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/master/api/test/index.js#L815) +### [`run()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L815) pass: number, fail: number }>} -## [TestRunner](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L896) +## [TestRunner](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L896) -### [`constructor(report)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L901) +### [`constructor(report)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L901) @@ -2351,7 +2351,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :---: | :---: | :--- | | report | (lines: string) => void | | true | | -### [`nextId()`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L953) +### [`nextId()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L953) @@ -2359,7 +2359,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :--- | | Not specified | string | | -### [`add(name, fn, only)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L963) +### [`add(name, fn, only)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L963) @@ -2369,7 +2369,7 @@ Retrieves the computed styles for a given element. | fn | TestFn | | false | | | only | boolean | | false | | -### [`run()`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L985) +### [`run()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L985) @@ -2377,7 +2377,7 @@ Retrieves the computed styles for a given element. | :--- | :--- | :--- | | Not specified | Promise | | -### [`onFinish())`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L1032) +### [`onFinish())`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L1032) @@ -2385,7 +2385,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/master/api/test/index.js#L1060) +## [`only(name, fn)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L1060) @@ -2394,7 +2394,7 @@ Retrieves the computed styles for a given element. | name | string | | false | | | fn | TestFn | | true | | -## [`skip(_name, _fn)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L1070) +## [`skip(_name, _fn)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L1070) @@ -2403,7 +2403,7 @@ Retrieves the computed styles for a given element. | _name | string | | false | | | _fn | TestFn | | true | | -## [`setStrict(strict)`](https://github.com/socketsupply/socket/blob/master/api/test/index.js#L1076) +## [`setStrict(strict)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/test/index.js#L1076) @@ -2415,7 +2415,7 @@ Retrieves the computed styles for a given element. -# [Window](https://github.com/socketsupply/socket/blob/master/api/window.js#L12) +# [Window](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L12) Provides ApplicationWindow class and methods @@ -2424,11 +2424,11 @@ Retrieves the computed styles for a given element. `socket:application` methods like `getCurrentWindow`, `createWindow`, `getWindow`, and `getWindows`. -## [ApplicationWindow](https://github.com/socketsupply/socket/blob/master/api/window.js#L32) +## [ApplicationWindow](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L32) Represents a window in the application -### [`index()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L60) +### [`index()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L60) Get the index of the window @@ -2436,7 +2436,7 @@ Get the index of the window | :--- | :--- | :--- | | Not specified | number | the index of the window | -### [`getSize()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L68) +### [`getSize()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L68) Get the size of the window @@ -2444,7 +2444,7 @@ Get the size of the window | :--- | :--- | :--- | | Not specified | { width: number, height: number | } - the size of the window | -### [`getTitle()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L79) +### [`getTitle()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L79) Get the title of the window @@ -2452,7 +2452,7 @@ Get the title of the window | :--- | :--- | :--- | | Not specified | string | the title of the window | -### [`getStatus()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L87) +### [`getStatus()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L87) Get the status of the window @@ -2460,7 +2460,7 @@ Get the status of the window | :--- | :--- | :--- | | Not specified | string | the status of the window | -### [`close()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L95) +### [`close()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L95) Close the window @@ -2468,7 +2468,7 @@ Close the window | :--- | :--- | :--- | | Not specified | Promise | the options of the window | -### [`show()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L110) +### [`show()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L110) Shows the window @@ -2476,7 +2476,7 @@ Shows the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`hide()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L119) +### [`hide()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L119) Hides the window @@ -2484,7 +2484,7 @@ Hides the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setTitle(title)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L129) +### [`setTitle(title)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L129) Sets the title of the window @@ -2496,7 +2496,7 @@ Sets the title of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setSize(opts)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L142) +### [`setSize(opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L142) Sets the size of the window @@ -2510,7 +2510,7 @@ Sets the size of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`navigate(path)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L182) +### [`navigate(path)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L182) Navigate the window to a given path @@ -2522,7 +2522,7 @@ Navigate the window to a given path | :--- | :--- | :--- | | Not specified | Promise | | -### [`showInspector()`](https://github.com/socketsupply/socket/blob/master/api/window.js#L191) +### [`showInspector()`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L191) Opens the Web Inspector for the window @@ -2530,7 +2530,7 @@ Opens the Web Inspector for the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setBackgroundColor(opts)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L208) +### [`setBackgroundColor(opts)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L208) Sets the background color of the window @@ -2546,7 +2546,7 @@ Sets the background color of the window | :--- | :--- | :--- | | Not specified | Promise | | -### [`setContextMenu(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L218) +### [`setContextMenu(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L218) Opens a native context menu. @@ -2558,7 +2558,7 @@ Opens a native context menu. | :--- | :--- | :--- | | Not specified | Promise | | -### [`showOpenFilePicker(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L235) +### [`showOpenFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L235) Shows a native open file dialog. @@ -2570,7 +2570,7 @@ Shows a native open file dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`showSaveFilePicker(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L253) +### [`showSaveFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L253) Shows a native save file dialog. @@ -2582,7 +2582,7 @@ Shows a native save file dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`showDirectoryFilePicker(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L271) +### [`showDirectoryFilePicker(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L271) Shows a native directory dialog. @@ -2594,7 +2594,7 @@ Shows a native directory dialog. | :--- | :--- | :--- | | Not specified | Promise | an array of file paths | -### [`send(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L296) +### [`send(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L296) This is a high-level API that you should use instead of `ipc.send` when you want to send a message to another window or to the backend. @@ -2608,7 +2608,7 @@ This is a high-level API that you should use instead of `ipc.send` when | options.event | string | | false | the event to send | | options.value | string \| object | | true | the value to send | -### [`openExternal(options)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L333) +### [`openExternal(options)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L333) Opens an URL in the default browser. @@ -2620,7 +2620,7 @@ Opens an URL in the default browser. | :--- | :--- | :--- | | Not specified | Promise | | -### [`addListener(event, cb)`](https://github.com/socketsupply/socket/blob/master/api/window.js#L344) +### [`addListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L344) Adds a listener to the window. @@ -2629,7 +2629,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/master/api/window.js#L362) +### [`on(event, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L362) Adds a listener to the window. An alias for `addListener`. @@ -2638,7 +2638,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/master/api/window.js#L379) +### [`once(event, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L379) Adds a listener to the window. The listener is removed after the first call. @@ -2647,7 +2647,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/master/api/window.js#L395) +### [`removeListener(event, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L395) Removes a listener from the window. @@ -2656,7 +2656,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/master/api/window.js#L408) +### [`removeAllListeners(event)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L408) Removes all listeners from the window. @@ -2664,7 +2664,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/master/api/window.js#L424) +### [`off(event, cb)`](https://github.com/socketsupply/socket/blob/v0.5.1/api/window.js#L424) Removes a listener from the window. An alias for `removeListener`. diff --git a/clib.json b/clib.json index 1246743c5..e8b760325 100644 --- a/clib.json +++ b/clib.json @@ -1,7 +1,7 @@ { "name": "socket", "repo": "socketsupply/socket", - "version": "0.5.0", + "version": "0.5.1", "description": "Build and package lean, fast, native desktop and mobile applications using the web technologies you already know.", "install": "install.sh", "src": [ diff --git a/npm/packages/@socketsupply/socket-darwin-arm64/package.json b/npm/packages/@socketsupply/socket-darwin-arm64/package.json index 9d5f5067e..f42af4fa4 100644 --- a/npm/packages/@socketsupply/socket-darwin-arm64/package.json +++ b/npm/packages/@socketsupply/socket-darwin-arm64/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket-darwin-arm64", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "src/index.js", diff --git a/npm/packages/@socketsupply/socket-darwin-x64/package.json b/npm/packages/@socketsupply/socket-darwin-x64/package.json index ab726f381..b1cd01ff0 100644 --- a/npm/packages/@socketsupply/socket-darwin-x64/package.json +++ b/npm/packages/@socketsupply/socket-darwin-x64/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket-darwin-x64", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "src/index.js", diff --git a/npm/packages/@socketsupply/socket-linux-arm64/package.json b/npm/packages/@socketsupply/socket-linux-arm64/package.json index 06f12178c..c14ad30d7 100644 --- a/npm/packages/@socketsupply/socket-linux-arm64/package.json +++ b/npm/packages/@socketsupply/socket-linux-arm64/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket-linux-arm64", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "src/index.js", diff --git a/npm/packages/@socketsupply/socket-linux-x64/package.json b/npm/packages/@socketsupply/socket-linux-x64/package.json index dde3f8deb..fa84adae4 100644 --- a/npm/packages/@socketsupply/socket-linux-x64/package.json +++ b/npm/packages/@socketsupply/socket-linux-x64/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket-linux-x64", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "src/index.js", diff --git a/npm/packages/@socketsupply/socket-win32-x64/package.json b/npm/packages/@socketsupply/socket-win32-x64/package.json index c6c054b3f..57e9db12a 100644 --- a/npm/packages/@socketsupply/socket-win32-x64/package.json +++ b/npm/packages/@socketsupply/socket-win32-x64/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket-win32-x64", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "src/index.js", diff --git a/npm/packages/@socketsupply/socket/package.json b/npm/packages/@socketsupply/socket/package.json index e244deac0..e507a52e2 100644 --- a/npm/packages/@socketsupply/socket/package.json +++ b/npm/packages/@socketsupply/socket/package.json @@ -1,6 +1,6 @@ { "name": "@socketsupply/socket", - "version": "0.5.0", + "version": "0.5.1", "description": "A Cross-Platform, Native Runtime for Desktop and Mobile Apps — Create apps using HTML, CSS, and JavaScript. Written from the ground up to be small and maintainable.", "type": "module", "main": "index.js", @@ -43,10 +43,10 @@ }, "homepage": "https://github.com/socketsupply/socket#readme", "optionalDependencies": { - "@socketsupply/socket-darwin-arm64": "0.5.0", - "@socketsupply/socket-darwin-x64": "0.5.0", - "@socketsupply/socket-linux-arm64": "0.5.0", - "@socketsupply/socket-linux-x64": "0.5.0", - "@socketsupply/socket-win32-x64": "0.5.0" + "@socketsupply/socket-darwin-arm64": "0.5.1", + "@socketsupply/socket-darwin-x64": "0.5.1", + "@socketsupply/socket-linux-arm64": "0.5.1", + "@socketsupply/socket-linux-x64": "0.5.1", + "@socketsupply/socket-win32-x64": "0.5.1" } }