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

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 scanning for published values that correspond to a well-known UUID

Start advertising a new value for a well-known UUID

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

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

Listen for datagram messages on a named port and optional address If address is not specified, the operating system will attempt to listen on all addresses. Once binding is complete, a 'listening' event is emitted and the optional callback function is called. If binding fails, an 'error' event is emitted.

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 address is not provided, '127.0.0.1' (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.

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 address is a host name, DNS will be used to resolve the address of the host. If address is not provided or otherwise nullish, '127.0.0.1' (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, '::0' for udp6 sockets.) An optional callback function may be specified to 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 are used. They are supported only when the first argument is a Buffer, a TypedArray, or a DataView.

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.

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.

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.

This is a VariableDeclaration named createSocketin dgram.js, it's exported but undocumented.

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

There are three important concepts for an application built with the Socket SDK. The Render process, the Main process, and the Bridge process. IPC is an acronym for Inter Process Communication. It's the method for which these [processes][processes] work together. The Bridge process handles communication between the Render and Main processes. For Desktop apps, the Render process is the user interface, and the Main process, which is optional, is strictly for computing and IO. When an applicaiton starts, the Bridge process will spawn a child process if one is specified. 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.

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

The query is encoded with encodeURIComponent. Here is a reference [implementation][0] if you would like to use a language that does not yet have one.

Represents an OK IPC status.

Represents an ERROR IPC status.

Timeout in milliseconds for IPC requests.

Symbol for the ipc.debug.enabled property

Parses seq as integer value

If debug.enabled === true, then debug output will be printed to console.

A result type used internally for handling IPC result values from the native layer that are in the form of { err?, data? }. The data and err properties on this type of object are in tuple form and be accessed at [data?,err?]

Creates a Result instance from input that may be an object like { err?, data? }, an Error instance, or just data.

Result class constructor.

This is a FunctionDeclaration named readyin ipc.js, it's exported but undocumented.

Sends a synchronous IPC command over XHR returning a Result upon success or error.

This is a FunctionDeclaration named emitin ipc.js, it's exported but undocumented.

This is a FunctionDeclaration named resolvein ipc.js, it's exported but undocumented.

This is a FunctionDeclaration named sendin ipc.js, it's exported but undocumented.

This is a FunctionDeclaration named writein ipc.js, it's exported but undocumented.

This is a FunctionDeclaration named requestin ipc.js, it's exported but undocumented.

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

This is a FunctionDeclaration named archin os.js, it's exported but undocumented.

This is a FunctionDeclaration named networkInterfacesin os.js, it's exported but undocumented.

This is a FunctionDeclaration named platformin os.js, it's exported but undocumented.

This is a FunctionDeclaration named typein os.js, it's exported but undocumented.

This is a VariableDeclaration named EOLin os.js, it's exported but undocumented.

This module provides an asynchronous network API for creating stream-based TCP or IPC servers (net.createServer()) and clients (net.createConnection()).

This is a ClassDeclaration named ``Server(extendsEventEmitter`)`in `net.js`, it's exported but undocumented.

This is a ClassDeclaration named ``Socket(extendsDuplex`)`in `net.js`, it's exported but undocumented.

This is a VariableDeclaration named connectin net.js, it's exported but undocumented.

This is a VariableDeclaration named createServerin net.js, it's exported but undocumented.

This is a VariableDeclaration named getNetworkInterfacesin net.js, it's exported but undocumented.

This is a VariableDeclaration named isIPv4in net.js, it's exported but undocumented.

This module enables interacting with the file system in a way modeled on standard POSIX functions. To use the promise-based APIs:

import

To use the callback and sync APIs:

import
as fs from 'node:fs';

Asynchronously check access a file for a given mode calling callback upon success or error.

This is a FunctionDeclaration named appendFilein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named chmodin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named chownin fs/index.js, it's exported but undocumented.

Asynchronously close a file descriptor calling callback upon success or error.

This is a FunctionDeclaration named copyFilein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named createReadStreamin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named createWriteStreamin fs/index.js, it's exported but undocumented.

Invokes the callback with the <fs.Stats> for the file descriptor. See the POSIX fstat(2) documentation for more detail.

This is a FunctionDeclaration named lchmodin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named lchownin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named lutimesin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named linkin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named lstatin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named mkdirin fs/index.js, it's exported but undocumented.

Asynchronously open a file calling callback upon success or error.

Asynchronously open a directory calling callback upon success or error.

Asynchronously read from an open file descriptor.

Asynchronously read all entries in a directory.

This is a FunctionDeclaration named readlinkin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named realpathin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named renamein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named rmdirin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named rmin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named statin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named symlinkin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named truncatein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named unlinkin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named utimesin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named watchin fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named writein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named writeFilein fs/index.js, it's exported but undocumented.

This is a FunctionDeclaration named writevin fs/index.js, it's exported but undocumented.