@socketsupply/socket v0.6.0-rc.8

Buffer

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

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

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

application

Provides Application level methods

Example usage:

import { createWindow } from 'socket:application'

MAX_WINDOWS

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

ApplicationWindowList

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

addEventListener(type, listener, |boolean)

Add an application event type callback listener with options.

removeEventListener(type, listener)

Remove an application event type callback listener with options.

getCurrentWindowIndex()

Returns the current window index

createWindow(opts)

Creates a new window and returns an instance of ApplicationWindow.

radius()

margin()

getScreenSize()

Returns the current screen size.

getWindows(indices)

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

getWindow(index)

Returns the ApplicationWindow instance for the given index

getCurrentWindow()

Returns the ApplicationWindow instance for the current window.

exit(code)

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

setSystemMenu(options)

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')
})

setTrayMenu()

An alias to setSystemMenu for creating a tary menu

setSystemMenuItemEnabled(value)

Set the enabled state of the system menu.

isPaused()

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

runtimeVersion

Socket Runtime version.

debug

Runtime debug flag.

config

Application configuration.

backend

The application's backend instance.

open(opts)

close()

bluetooth

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

Example usage:

import { Bluetooth } from 'socket:bluetooth'

Bluetooth (extends EventEmitter)

Create an instance of a Bluetooth service.

constructor(serviceId)

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

start()

Start the Bluetooth service.

subscribe(id)

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
})

publish(id, value)

Start advertising a new value for a well-known UUID

crypto

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

Example usage:

import { randomBytes } from 'socket:crypto'

webcrypto

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

ready

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

getRandomValues(buffer)

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

rand64()

Generate a random 64-bit number.

RANDOM_BYTES_QUOTA

Maximum total size of random bytes per page

MAX_RANDOM_BYTES

Maximum total size for random bytes.

MAX_RANDOM_BYTES_PAGES

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

randomBytes(size)

Generate size random bytes.

createDigest(algorithm, message)

murmur3(value, seed)

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

dgram

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'

createSocket(options, callback)

Creates a Socket instance.

Socket (extends EventEmitter)

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)

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.

connect(port, host, connectListener)

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.

disconnect()

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.

send(msg, offset, length, port, address, callback)

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.

close(callback)

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.

address()

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.

remoteAddress()

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.

setRecvBufferSize(size)

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

setSendBufferSize(size)

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

getRecvBufferSize()

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

getSendBufferSize()

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

code()

ERR_SOCKET_ALREADY_BOUND (extends SocketError)

Thrown when a socket is already bound.

ERR_SOCKET_DGRAM_IS_CONNECTED (extends SocketError)

Thrown when the socket is already connected.

ERR_SOCKET_DGRAM_NOT_CONNECTED (extends SocketError)

Thrown when the socket is not connected.

ERR_SOCKET_DGRAM_NOT_RUNNING (extends SocketError)

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

ERR_SOCKET_BAD_TYPE (extends TypeError)

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

ERR_SOCKET_BAD_PORT (extends RangeError)

Thrown when a bad port is given.

dns

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'

lookup(hostname, options, cb)

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().

dns.promises

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'

lookup(hostname, opts)

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

fs

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';

access(path, mode, callback)

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.

accessSync(path, mode)

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.

exists(path, callback)

Checks if a path exists

existsSync(path, callback)

Checks if a path exists

chmod(path, mode, callback)

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

chmodSync(path, mode)

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

chown(path, uid, gid, callback)

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

chownSync(path, uid, gid)

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

close(fd, callback)

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

closeSync(fd)

Synchronously close a file descriptor.

copyFile(src, dest, flags, callback)

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

copyFileSync(src, dest, flags)

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

createReadStream(path, options)

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

createWriteStream(path, options)

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

fstat(fd, options, callback)

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.

fsync(fd, callback)

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

ftruncate(fd, offset, callback)

Truncates the file up to offset bytes.

lchown(path, uid, gid, callback)

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

link(src, dest, )

Creates a link to dest from src.

open(path, flags, mode, options, callback)

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

openSync(path, flags, mode, options)

Synchronously open a file.

opendir(path, options, callback)

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

opendirSync(path, options)

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

read(fd, buffer, offset, length, position, callback)

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

write(fd, buffer, offset, length, position, callback)

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

readdir(path, options, callback)

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

readdirSync(path, options)

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

readFile(path, options, callback)

readFileSync(path, } options, options)

readlink(path, callback)

Reads link at path

realpath(path, callback)

Computes real path for path

realpathSync(path)

Computes real path for path

rename(src, dest, callback)

Renames file or directory at src to dest.

renameSync(src, dest)

Renames file or directory at src to dest, synchronously.

rmdir(path, callback)

Removes directory at path.

rmdirSync(path)

Removes directory at path, synchronously.

statSync(path, options)

Synchronously get the stats of a file

stat(path, options, callback)

Get the stats of a file

lstat(path, options, callback)

Get the stats of a symbolic link

symlink(src, dest)

Creates a symlink of src at dest.

unlink(path, callback)

Unlinks (removes) file at path.

unlinkSync(path)

Unlinks (removes) file at path, synchronously.

writeFile(path, data, options, callback)

writeFileSync(path, data, options)

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

watch(, options, callback)

Watch for changes at path calling callback

fs.promises

• 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.

  Directory	Description
  Documents	The app’s sandboxed documents directory. The contents of this directory are backed up by iTunes and may be set as accessible to the user via iTunes when UIFileSharingEnabled is set to true in the application's info.plist.
  Library	The app’s sandboxed library directory. The contents of this directory are synchronized via iTunes (except the Library/Caches subdirectory, see below), but never exposed to the user.
  Library/Caches	The app’s sandboxed caches directory. The contents of this directory are not synchronized via iTunes and may be deleted by the system at any time. It's a good place to store data which provides a good offline-first experience for the user.
  Library/Preferences	The app’s sandboxed preferences directory. The contents of this directory are synchronized via iTunes. Its purpose is to be used by the Settings app. Avoid creating your own files in this directory.
  tmp	The app’s sandboxed temporary directory. The contents of this directory are not synchronized via iTunes and may be deleted by the system at any time. Although, it's recommended that you delete data that is not necessary anymore manually to minimize the space your app takes up on the file system. Use this directory to store data that is only useful during the app runtime.

  Example usage:

  import fs from 'socket:fs/promises'

access(path, mode, options)

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

chmod(path, mode)

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

chown(path, uid, gid)

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

copyFile(src, dest, flags)

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

lchown(path, uid, gid)

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

link(src, dest)

Creates a link to dest from dest.

mkdir(path, options)

Asynchronously creates a directory.

open(path, flags, mode)

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

opendir(path, options)

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

|