Buffer module is a third party vendor module provided by Feross Aboukhadijeh and other contributors (MIT License).

External docs: https://nodejs.org/api/buffer.html

Events module is a third party module provided by Browserify and Node.js contributors (MIT License).

External docs: https://nodejs.org/api/events.html

Provides Application level methods

Example usage:

import { createWindow } from 'socket:application'

This is a VariableDeclaration named MAX_WINDOWS in api/application.js, it's exported but undocumented.

This is a ClassDeclaration named ApplicationWindowList in api/application.js, it's exported but undocumented.

Add an application event type callback listener with options.

Remove an application event type callback listener with options.

Returns the current window index

Creates a new window and returns an instance of ApplicationWindow.

Returns the current screen size.

Returns the ApplicationWindow instances for the given indices or all windows if no indices are provided.

Returns the ApplicationWindow instance for the given index

Returns the ApplicationWindow instance for the current window.

Quits the backend process and then quits the render process, the exit code used is the final exit code to the OS.

Set the native menu for the app.

Socket Runtime provides a minimalist DSL that makes it easy to create cross platform native system and context menus.

Menus are created at run time. They can be created from either the Main or Render process. The can be recreated instantly by calling the setSystemMenu method.

The method takes a string. Here's an example of a menu. The semi colon is significant indicates the end of the menu. Use an underscore when there is no accelerator key. Modifiers are optional. And well known OS menu options like the edit menu will automatically get accelerators you dont need to specify them.

socket.application.setSystemMenu({ index: 0, value: `
  App:
    Foo: f;

  Edit:
    Cut: x
    Copy: c
    Paste: v
    Delete: _
    Select All: a;

  Other:
    Apple: _
    Another Test: T
    !Im Disabled: I
    Some Thing: S + Meta
    ---
    Bazz: s + Meta, Control, Alt;
`)

Separators

To create a separator, use three dashes ---.

Accelerator Modifiers

Accelerator modifiers are used as visual indicators but don't have a material impact as the actual key binding is done in the event listener.

A capital letter implies that the accelerator is modified by the Shift key.

Additional accelerators are Meta, Control, Option, each separated by commas. If one is not applicable for a platform, it will just be ignored.

On MacOS Meta is the same as Command.

Disabled Items

If you want to disable a menu item just prefix the item with the ! character. This will cause the item to appear disabled when the system menu renders.

Submenus

We feel like nested menus are an anti-pattern. We don't use them. If you have a strong argument for them and a very simple pull request that makes them work we may consider them.

Event Handling

When a menu item is activated, it raises the menuItemSelected event in the front end code, you can then communicate with your backend code if you want from there.

For example, if the Apple item is selected from the Other menu...

window.addEventListener('menuItemSelected', event => {
  assert(event.detail.parent === 'Other')
  assert(event.detail.title === 'Apple')
})

An alias to setSystemMenu for creating a tary menu

Set the enabled state of the system menu.

Predicate function to determine if application is in a "paused" state.

Socket Runtime version.

Runtime debug flag.

Application configuration.

The application's backend instance.

A high-level, cross-platform API for Bluetooth Pub-Sub

Example usage:

import { Bluetooth } from 'socket:bluetooth'

Create an instance of a Bluetooth service.

constructor is an example property that is set to true Creates a new service with key-value pairs

Start the Bluetooth service.

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 emitted. To receive these events you can add an event listener, for example...

const ble = new Bluetooth(id)
ble.subscribe(uuid)
ble.on(uuid, (data, details) => {
  // ...do something interesting
})

Start advertising a new value for a well-known UUID

Some high-level methods around the crypto.subtle API for getting random bytes and hashing.

Example usage:

import { randomBytes } from 'socket:crypto'

External docs: https://developer.mozilla.org/en-US/docs/Web/API/Crypto WebCrypto API

A promise that resolves when all internals to be loaded/ready.

External docs: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues Generate cryptographically strong random values into the buffer

Generate a random 64-bit number.

Maximum total size of random bytes per page

Maximum total size for random bytes.

Maximum total amount of allocated per page of bytes (max/quota)

Generate size random bytes.

A murmur3 hash implementation based on https://github.com/jwerle/murmurhash.c that works on strings and ArrayBuffer views (typed arrays)

This module provides an implementation of UDP datagram sockets. It does not (yet) provide any of the multicast methods or properties.

Example usage:

import { createSocket } from 'socket:dgram'

Creates a Socket instance.

New instances of dgram.Socket are created using dgram.createSocket(). The new keyword is not to be used to create dgram.Socket instances.

External docs: https://nodejs.org/api/dgram.html#socketbindport-address-callback Listen for datagram messages on a named port and optional address If the address is not specified, the operating system will attempt to listen on all addresses. Once the binding is complete, a 'listening' event is emitted and the optional callback function is called.

If binding fails, an 'error' event is emitted.

External docs: https://nodejs.org/api/dgram.html#socketconnectport-address-callback Associates the dgram.Socket to a remote address and port. Every message sent by this handle is automatically sent to that destination. Also, the socket will only receive messages from that remote peer. Trying to call connect() on an already connected socket will result in an ERR_SOCKET_DGRAM_IS_CONNECTED exception. If the address is not provided, '0.0.0.0' (for udp4 sockets) or '::1' (for udp6 sockets) will be used by default. Once the connection is complete, a 'connect' event is emitted and the optional callback function is called. In case of failure, the callback is called or, failing this, an 'error' event is emitted.

External docs: https://nodejs.org/api/dgram.html#socketdisconnect A synchronous function that disassociates a connected dgram.Socket from its remote address. Trying to call disconnect() on an unbound or already disconnected socket will result in an ERR_SOCKET_DGRAM_NOT_CONNECTED exception.

External docs: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback Broadcasts a datagram on the socket. For connectionless sockets, the destination port and address must be specified. Connected sockets, on the other hand, will use their associated remote endpoint, so the port and address arguments must not be set.

The msg argument contains the message to be sent. Depending on its type, different behavior can apply. If msg is a Buffer, any TypedArray, or a DataView, the offset and length specify the offset within the Buffer where the message begins and the number of bytes in the message, respectively. If msg is a String, then it is automatically converted to a Buffer with 'utf8' encoding. With messages that contain multi-byte characters, offset, and length will be calculated with respect to byte length and not the character position. If msg is an array, offset and length must not be specified.

The address argument is a string. If the value of the address is a hostname, DNS will be used to resolve the address of the host. If the address is not provided or otherwise nullish, '0.0.0.0' (for udp4 sockets) or '::1' (for udp6 sockets) will be used by default.

If the socket has not been previously bound with a call to bind, the socket is assigned a random port number and is bound to the "all interfaces" address ('0.0.0.0' for udp4 sockets, '::1' for udp6 sockets.)

An optional callback function may be specified as a way of reporting DNS errors or for determining when it is safe to reuse the buf object. DNS lookups delay the time to send for at least one tick of the Node.js event loop.

The only way to know for sure that the datagram has been sent is by using a callback. If an error occurs and a callback is given, the error will be passed as the first argument to the callback. If a callback is not given, the error is emitted as an 'error' event on the socket object.

Offset and length are optional but both must be set if either is used. They are supported only when the first argument is a Buffer, a TypedArray, or a DataView.

External docs: https://nodejs.org/api/dgram.html#socketclosecallback Close the underlying socket and stop listening for data on it. If a callback is provided, it is added as a listener for the 'close' event.

External docs: https://nodejs.org/api/dgram.html#socketaddress Returns an object containing the address information for a socket. For UDP sockets, this object will contain address, family, and port properties.

This method throws EBADF if called on an unbound socket.

External docs: https://nodejs.org/api/dgram.html#socketremoteaddress Returns an object containing the address, family, and port of the remote endpoint. This method throws an ERR_SOCKET_DGRAM_NOT_CONNECTED exception if the socket is not connected.

External docs: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize Sets the SO_RCVBUF socket option. Sets the maximum socket receive buffer in bytes.

External docs: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize Sets the SO_SNDBUF socket option. Sets the maximum socket send buffer in bytes.

External docs: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize

External docs: https://nodejs.org/api/dgram.html#socketgetsendbuffersize

Thrown when a socket is already bound.

Thrown when the socket is already connected.

Thrown when the socket is not connected.

Thrown when the socket is not running (not bound or connected).

Thrown when a bad socket type is used in an argument.

Thrown when a bad port is given.

This module enables name resolution. For example, use it to look up IP addresses of host names. Although named for the Domain Name System (DNS), it does not always use the DNS protocol for lookups. dns.lookup() uses the operating system facilities to perform name resolution. It may not need to perform any network communication. To perform name resolution the way other applications on the same system do, use dns.lookup().

Example usage:

import { lookup } from 'socket:dns'

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 AAAA (IPv6) record. All option properties are optional. If options is an integer, then it must be 4 or 6 – if options is 0 or not provided, then IPv4 and IPv6 addresses are both returned if found.

From the node.js website...

With the all option set to true, the arguments for callback change to (err, addresses), with addresses being an array of objects with the properties address and family.

On error, err is an Error object, where err.code is the error code. Keep in mind that err.code will be set to 'ENOTFOUND' not only when the host name does not exist but also when the lookup fails in other ways such as no available file descriptors. dns.lookup() does not necessarily have anything to do with the DNS protocol. The implementation uses an operating system facility that can associate names with addresses and vice versa. This implementation can have subtle but important consequences on the behavior of any Node.js program. Please take some time to consult the Implementation considerations section before using dns.lookup().

This module enables name resolution. For example, use it to look up IP addresses of host names. Although named for the Domain Name System (DNS), it does not always use the DNS protocol for lookups. dns.lookup() uses the operating system facilities to perform name resolution. It may not need to perform any network communication. To perform name resolution the way other applications on the same system do, use dns.lookup().

Example usage:

import { lookup } from 'socket:dns/promises'

External docs: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

This module enables interacting with the file system in a way modeled on standard POSIX functions.

The Application Sandbox restricts access to the file system.

iOS Application Sandboxing has a set of rules that limits access to the file system. Apps can only access files in their own sandboxed home directory.

Example usage:

import * as fs from 'socket:fs';

External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Asynchronously check access a file for a given mode calling callback upon success or error.

External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Synchronously check access a file for a given mode calling callback upon success or error.

Checks if a path exists

Checks if a path exists

External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback Asynchronously changes the permissions of a file. No arguments other than a possible exception are given to the completion callback

External docs: https://nodejs.org/api/fs.html#fschmodpath-mode-callback Synchronously changes the permissions of a file.

Changes ownership of file or directory at path with uid and gid.

Changes ownership of file or directory at path with uid and gid.

External docs: https://nodejs.org/api/fs.html#fsclosefd-callback Asynchronously close a file descriptor calling callback upon success or error.

Synchronously close a file descriptor.

External docs: https://nodejs.org/api/fs.html#fscopyfilesrc-dest-mode-callback Asynchronously copies src to dest calling callback upon success or error.

External docs: https://nodejs.org/api/fs.html#fscopyfilesrc-dest-mode-callback Synchronously copies src to dest calling callback upon success or error.

External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options

External docs: https://nodejs.org/api/fs.html#fscreatewritestreampath-options

External docs: https://nodejs.org/api/fs.html#fsfstatfd-options-callback Invokes the callback with the <fs.Stats> for the file descriptor. See the POSIX fstat(2) documentation for more detail.

Request that all data for the open file descriptor is flushed to the storage device.

Truncates the file up to offset bytes.

Chages ownership of link at path with uid and `gid.

Creates a link to dest from src.

External docs: https://nodejs.org/api/fs.html#fsopenpath-flags-mode-callback Asynchronously open a file calling callback upon success or error.

Synchronously open a file.

External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Asynchronously open a directory calling callback upon success or error.

External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Synchronously open a directory.

External docs: https://nodejs.org/api/fs.html#fsreadfd-buffer-offset-length-position-callback Asynchronously read from an open file descriptor.

External docs: https://nodejs.org/api/fs.html#fswritefd-buffer-offset-length-position-callback Asynchronously write to an open file descriptor.

External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Asynchronously read all entries in a directory.

External docs: https://nodejs.org/api/fs.html#fsreaddirpath-options-callback Synchronously read all entries in a directory.

Reads link at path

Computes real path for path

Computes real path for path

Renames file or directory at src to dest.

Renames file or directory at src to dest, synchronously.

Removes directory at path.

Removes directory at path, synchronously.

Synchronously get the stats of a file

Get the stats of a file

Get the stats of a symbolic link

Creates a symlink of src at dest.

Unlinks (removes) file at path.

Unlinks (removes) file at path, synchronously.

External docs: https://nodejs.org/api/fs.html#fswritefilesyncfile-data-options Writes data to a file synchronously.

Watch for changes at path calling callback

• This module enables interacting with the file system in a way modeled on standard POSIX functions.

The Application Sandbox restricts access to the file system.

iOS Application Sandboxing has a set of rules that limits access to the file system. Apps can only access files in their own sandboxed home directory.

Example usage:

import fs from 'socket:fs/promises'

External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesaccesspath-mode Asynchronously check access a file.

External docs: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

Changes ownership of file or directory at path with uid and gid.

Asynchronously copies src to dest calling callback upon success or error.

Chages ownership of link at path with uid and `gid.

Creates a link to dest from dest.

Asynchronously creates a directory.

External docs: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode Asynchronously open a file.

External docs: https://nodejs.org/api/fs.html#fspromisesopendirpath-options

External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreaddirpath-options

External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromisesreadfilepath-options

Reads link at path

Computes real path for path

Renames file or directory at src to dest.

Removes directory at path.

External docs: https://nodejs.org/api/fs.html#fspromisesstatpath-options Get the stats of a file

External docs: https://nodejs.org/api/fs.html#fspromiseslstatpath-options Get the stats of a symbolic link.

Creates a symlink of src at dest.

Unlinks (removes) file at path.

External docs: https://nodejs.org/dist/latest-v20.x/docs/api/fs.html#fspromiseswritefilefile-data-options

Watch for changes at path calling callback

This is a low-level API that you don't need unless you are implementing a library on top of Socket runtime. A Socket app has one or more processes.

When you need to send a message to another window or to the backend, you should use the application module to get a reference to the window and use the send method to send a message.

• The Render process, is the UI where the HTML, CSS, and JS are run.
• The Bridge process, is the thin layer of code that manages everything.
• The Main process, is for apps that need to run heavier compute jobs. And unlike electron it's optional.

The Bridge process manages the Render and Main process, it may also broker data between them.

The Binding process uses standard input and output as a way to communicate. Data written to the write-end of the pipe is buffered by the OS until it is read from the read-end of the pipe.

The IPC protocol uses a simple URI-like scheme. Data is passed as ArrayBuffers.

ipc://command?key1=value1&key2=value2...

Example usage:

import { send } from 'socket:ipc'

This is a FunctionDeclaration named maybeMakeError in api/ipc.js, it's exported but undocumented.

This is a ClassDeclaration named ``IPCSearchParams(extendsURLSearchParams`)` in `api/ipc.js`, it's exported but undocumented.

Emit event to be dispatched on window object.

Sends an async IPC command request with parameters.

This is a FunctionDeclaration named inflateIPCMessageTransfers in api/ipc.js, it's exported but undocumented.

This is a FunctionDeclaration named findIPCMessageTransfers in api/ipc.js, it's exported but undocumented.

This is a VariableDeclaration named ports in api/ipc.js, it's exported but undocumented.

This is a ClassDeclaration named ``IPCMessagePort(extendsMessagePort`)` in `api/ipc.js`, it's exported but undocumented.

This is a ClassDeclaration named ``IPCMessageChannel(extendsMessageChannel`)` in `api/ipc.js`, it's exported but undocumented.

External docs: https://socketsupply.co/guides/#p2p-guide

Provides a higher level API over the latica protocol.

This module provides normalized system information from all the major operating systems.

Example usage:

import { arch, platform } from 'socket:os'

Returns the operating system CPU architecture for which Socket was compiled.

External docs: https://nodejs.org/api/os.html#os_os_cpus Returns an array of objects containing information about each CPU/core. The properties of the objects are:

• model <string> - CPU model name.
• speed <number> - CPU clock speed (in MHz).
• times <object> - An object containing the fields user, nice, sys, idle, irq representing the number of milliseconds the CPU has spent in each mode.
  • user <number> - Time spent by this CPU or core in user mode.
  • nice <number> - Time spent by this CPU or core in user mode with low priority (nice).
  • sys <number> - Time spent by this CPU or core in system mode.
  • idle <number> - Time spent by this CPU or core in idle mode.
  • irq <number> - Time spent by this CPU or core in IRQ mode.

External docs: https://nodejs.org/api/os.html#os_os_networkinterfaces Returns an object containing network interfaces that have been assigned a network address. Each key on the returned object identifies a network interface. The associated value is an array of objects that each describe an assigned network address. The properties available on the assigned network address object include:

• address <string> - The assigned IPv4 or IPv6 address.
• netmask <string> - The IPv4 or IPv6 network mask.
• family <string> - The address family ('IPv4' or 'IPv6').
• mac <string> - The MAC address of the network interface.
• internal <boolean> - Indicates whether the network interface is a loopback interface.
• scopeid <number> - The numeric scope ID (only specified when family is 'IPv6').
• cidr <string> - The CIDR notation of the interface.

External docs: https://nodejs.org/api/os.html#os_os_platform Returns the operating system platform. The returned value is equivalent to process.platform.

External docs: https://nodejs.org/api/os.html#os_os_type Returns the operating system name.

The operating system's end-of-line marker. '\r\n' on Windows and '\n' on POSIX.

Get resource usage.

Returns the system uptime in seconds.

Returns the operating system name.

Returns the home directory of the current user.

Example usage:

import { Path } from 'socket:path'

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.

Computes current working directory for a path

Computed location origin. Defaults to socket:/// if not available.

Computes the relative path from from to to.

Joins path components. This function may not return an absolute path.

Computes directory name of path.

Computes base name of path.

Computes extension name of path.

Computes normalized path

Formats Path object into a string.

Parses input path into a Path instance.

A container for a parsed Path.

Creates a Path instance from input and optional cwd.

Path class constructor.

true if the path is relative, otherwise `false.

The working value of this path.

The original source, unresolved.

Computed parent path.

Computed root in path.

Computed directory name in path.

Computed base name in path.

Computed base name in path without path extension.

Computed extension name in path.

The computed drive, if given in the path.

Converts this Path instance to a string.

Example usage:

import process from 'socket:process'

This is a ClassDeclaration named ``ProcessEnvironmentEvent(extendsEvent`)` in `api/process.js`, it's exported but undocumented.

This is a ClassDeclaration named ``ProcessEnvironment(extendsEventTarget`)` in `api/process.js`, it's exported but undocumented.

This is a VariableDeclaration named env in api/process.js, it's exported but undocumented.

Adds callback to the 'nextTick' queue.

Computed high resolution time as a BigInt.

Returns an object describing the memory usage of the Node.js process measured in bytes.

Provides a test runner for Socket Runtime.

Example usage:

import { test } from 'socket:test'

test('test name', async t => {
  t.equal(1, 1)
})

Plan the number of assertions.

Sleep for ms with an optional msg

await t.sleep(100)

Request animation frame with an optional msg. Falls back to a 0ms setTimeout when tests are run headlessly.

await t.requestAnimationFrame()

Dispatch the `click`` method on an element specified by selector.

await t.click('.class button', 'Click a button')

Dispatch the click window.MouseEvent on an element specified by selector.

await t.eventClick('.class button', 'Click a button with an event')

Dispatch an event on the target.

await t.dispatchEvent('my-event', '#my-div', 'Fire the my-event event')

Call the focus method on element specified by selector.

await t.focus('#my-div')

Call the blur method on element specified by selector.

await t.blur('#my-div')

Consecutively set the str value of the element specified by selector to simulate typing.

await t.typeValue('#my-div', 'Hello World', 'Type "Hello World" into #my-div')

appendChild an element el to a parent selector element.

const myElement = createElement('div')
await t.appendChild('#parent-selector', myElement, 'Append myElement into #parent-selector')

Remove an element from the DOM.

await t.removeElement('#dom-selector', 'Remove #dom-selector')

Test if an element is visible

await t.elementVisible('#dom-selector','Element is visible')

Test if an element is invisible

await t.elementInvisible('#dom-selector','Element is invisible')

Test if an element is invisible

await t.waitFor('#dom-selector', { visible: true },'#dom-selector is on the page and visible')

Test if an element is invisible

await t.waitForText('#dom-selector', 'Text to wait for')

await t.waitForText('#dom-selector', /hello/i)

await t.waitForText('#dom-selector', {
  text: 'Text to wait for',
  multipleTags: true
})

Run a querySelector as an assert and also get the results

const element = await t.querySelector('#dom-selector')

Run a querySelectorAll as an assert and also get the results

const elements = await t.querySelectorAll('#dom-selector', '')

Retrieves the computed styles for a given element.

// Using CSS selector
const style = getComputedStyle('.my-element', 'Custom success message');

// Using Element object
const el = document.querySelector('.my-element');
const style = getComputedStyle(el);

pass: number, fail: number }>}

Provides ApplicationWindow class and methods

Don't use this module directly, get instances of ApplicationWindow with socket:application methods like getCurrentWindow, createWindow, getWindow, and getWindows.

Represents a window in the application

The unique ID of this window.

Get the index of the window

The broadcast channel for this window.

Get the size of the window

Get the position of the window

Get the title of the window

Get the status of the window

Close the window

Shows the window

Hides the window

Maximize the window

Minimize the window

Restore the window

Sets the title of the window

Sets the size of the window

Sets the position of the window

Navigate the window to a given path

Opens the Web Inspector for the window

Sets the background color of the window

Gets the background color of the window

Opens a native context menu.

Shows a native open file dialog.

Shows a native save file dialog.

Shows a native directory dialog.

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.

Post a message to a window TODO(@jwerle): research using BroadcastChannel instead