socket api

bluetooth

Una API multiplataforma de alto nivel para Bluetooth Pub-Sub

Bluetooth (extiende EventEmitter )

Cree una instancia de un servicio Bluetooth.

constructor(serviceId)

constructor es una propiedad de ejemplo que se establece en true Crea un nuevo servicio con pares clave-valor.

Argumento	Tipo	Por defecto	Opcional	Descripción
ID de servicio	cadena		FALSO	Dado un valor predeterminado para determinar el tipo

start()

Inicie el servicio bluetooth.

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

subscribe(id )

Comience a buscar valores publicados que correspondan a un UUID conocido. Una vez suscrito a un UUID, se emitirán los eventos que correspondan a ese UUID. Para recibir estos eventos puedes agregar un detector de eventos, por ejemplo...

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

Argumento	Tipo	Por defecto	Opcional	Descripción
identificación	cadena		FALSO	Un UUID conocido

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

publish(id, value)

Comience a anunciar un nuevo valor para un UUID conocido

Argumento	Tipo	Por defecto	Opcional	Descripción
identificación	cadena		FALSO	Un UUID conocido
valor	cadena		FALSO

Valor de retorno	Tipo	Descripción
No especificado	Promesa

Buffer

Documentos externos: https://nodejs.org/api/buffer.html#buffer_class_buffer

El módulo de búfer de node.js, para el navegador.

Buffer

Si Buffer.TYPED_ARRAY_SUPPORT : === true Utilice la implementación Uint8Array (la más rápida) === false Imprima la advertencia y recomiende usar buffer v4.x que tiene una implementación de Objeto (la más compatible, incluso IE6)

Los navegadores que admiten matrices escritas son IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Informamos que el navegador no admite matrices escritas si no se pueden subclasificar mediante proto . Firefox 4-29 carece de soporte para agregar nuevas propiedades a Uint8Array (consulte: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 carece de soporte para proto y tiene una implementación de matriz escrita con errores.

indefinido

Si Buffer.TYPED_ARRAY_SUPPORT : === true Utilice la implementación Uint8Array (la más rápida) === false Imprima la advertencia y recomiende usar buffer v4.x que tiene una implementación de Objeto (la más compatible, incluso IE6)

Los navegadores que admiten matrices escritas son IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Informamos que el navegador no admite matrices escritas si no se pueden subclasificar mediante proto . Firefox 4-29 carece de soporte para agregar nuevas propiedades a Uint8Array (consulte: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 carece de soporte para proto y tiene una implementación de matriz escrita con errores.

indefinido

Si Buffer.TYPED_ARRAY_SUPPORT : === true Utilice la implementación Uint8Array (la más rápida) === false Imprima la advertencia y recomiende usar buffer v4.x que tiene una implementación de Objeto (la más compatible, incluso IE6)

Los navegadores que admiten matrices escritas son IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Informamos que el navegador no admite matrices escritas si no se pueden subclasificar mediante proto . Firefox 4-29 carece de soporte para agregar nuevas propiedades a Uint8Array (consulte: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 carece de soporte para proto y tiene una implementación de matriz escrita con errores.

indefinido

Si Buffer.TYPED_ARRAY_SUPPORT : === true Utilice la implementación Uint8Array (la más rápida) === false Imprima la advertencia y recomiende usar buffer v4.x que tiene una implementación de Objeto (la más compatible, incluso IE6)

Los navegadores que admiten matrices escritas son IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Informamos que el navegador no admite matrices escritas si no se pueden subclasificar mediante proto . Firefox 4-29 carece de soporte para agregar nuevas propiedades a Uint8Array (consulte: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 carece de soporte para proto y tiene una implementación de matriz escrita con errores.

indefinido

El constructor Buffer devuelve instancias de Uint8Array cuyo prototipo se cambió a Buffer.prototype . Además, Buffer es una subclase de Uint8Array , por lo que las instancias devueltas tendrán todos los métodos Buffer del nodo y los métodos Uint8Array . La notación entre corchetes funciona como se esperaba: devuelve un solo octeto.

El prototipo Uint8Array permanece sin modificaciones.

Buffer

Funcionalmente equivalente a Buffer(arg, codificación) pero arroja un TypeError si el valor es un número. Buffer.from(cadena[, codificación]) Buffer.from(matriz) Buffer.from(búfer) Buffer.from(matrizBuffer[, byteOffset[, longitud]])

indefinido

Funcionalmente equivalente a Buffer(arg, codificación) pero arroja un TypeError si el valor es un número. Buffer.from(cadena[, codificación]) Buffer.from(matriz) Buffer.from(búfer) Buffer.from(matrizBuffer[, byteOffset[, longitud]])

indefinido

Funcionalmente equivalente a Buffer(arg, codificación) pero arroja un TypeError si el valor es un número. Buffer.from(cadena[, codificación]) Buffer.from(matriz) Buffer.from(búfer) Buffer.from(matrizBuffer[, byteOffset[, longitud]])

indefinido

Funcionalmente equivalente a Buffer(arg, codificación) pero arroja un TypeError si el valor es un número. Buffer.from(cadena[, codificación]) Buffer.from(matriz) Buffer.from(búfer) Buffer.from(matrizBuffer[, byteOffset[, longitud]])

Buffer

Crea una nueva instancia de Buffer llena. alloc(tamaño[, relleno[, codificación]])

indefinido

Crea una nueva instancia de Buffer llena. alloc(tamaño[, relleno[, codificación]])

indefinido

Crea una nueva instancia de Buffer llena. alloc(tamaño[, relleno[, codificación]])

indefinido

Crea una nueva instancia de Buffer llena. alloc(tamaño[, relleno[, codificación]])

Buffer

Equivalente a Buffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a Buffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a Buffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a Buffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

Buffer

Equivalente a SlowBuffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a SlowBuffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a SlowBuffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

indefinido

Equivalente a SlowBuffer (num), de forma predeterminada crea una instancia de Buffer distinta de cero.

Cripto

Algunos métodos de alto nivel relacionados con la API crypto.subtle para obtener bytes aleatorios y hash.

criptomoneda web

API WebCrypto

getRandomValues(buffer)

Documentos externos: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues

Genere valores aleatorios criptográficamente fuertes en buffer

Argumento	Tipo	Por defecto	Opcional	Descripción
buffer	Matriz mecanografiada		FALSO

Valor de retorno	Tipo	Descripción
No especificado	Matriz mecanografiada

RANDOM_BYTES_QUOTA

Tamaño total máximo de bytes aleatorios por página

MAX_RANDOM_BYTES

Tamaño total máximo para bytes aleatorios.

MAX_RANDOM_BYTES_PAGES

Cantidad total máxima de bytes asignados por página (máx./cuota)

randomBytes(size)

Genera bytes aleatorios size .

Argumento	Tipo	Por defecto	Opcional	Descripción
tamaño	número		FALSO	El número de bytes a generar. El tamaño no debe ser mayor que 2**31 - 1.

Valor de retorno	Tipo	Descripción
No especificado	Buffer	Una promesa que se resuelve con una instancia de socket.Buffer con bytes aleatorios.

createDigest(algorithm, message)

Argumento	Tipo	Por defecto	Opcional	Descripción
algoritmo	cadena		FALSO	SHA-1
mensaje	Búfer | Matriz mecanografiada | Vista de datos		FALSO	Una instancia de socket.Buffer, TypedArray o Dataview.

Valor de retorno	Tipo	Descripción
No especificado	Promesa	Una promesa que se resuelve con una instancia de socket.Buffer con el hash.

Dgrama

Este módulo proporciona una implementación de sockets de datagramas UDP. No proporciona (todavía) ninguno de los métodos o propiedades de multidifusión.

ERR_SOCKET_ALREADY_BOUND (extiende SocketError )

Se lanza cuando un socket ya está vinculado.

ERR_SOCKET_DGRAM_IS_CONNECTED (extiende SocketError )

Lanzado cuando el enchufe ya está conectado.

ERR_SOCKET_DGRAM_NOT_CONNECTED (extiende SocketError )

Lanzado cuando el enchufe no está conectado.

ERR_SOCKET_DGRAM_NOT_RUNNING (extiende SocketError )

Lanzado cuando el enchufe no está funcionando (no atado ni conectado).

ERR_SOCKET_BAD_TYPE (extiende TypeError )

Se produce cuando se utiliza un tipo de socket incorrecto en un argumento.

ERR_SOCKET_BAD_PORT (extiende RangeError )

Lanzado cuando se da un mal puerto.

createSocket(options, callback)

Crea una instancia Socket . si ()

Argumento	Tipo	Por defecto	Opcional	Descripción
opciones	cadena | Objeto		FALSO	ya sea una cadena ('udp4' o 'udp6') o un objeto de opciones
opciones.tipo	cadena		verdadero	La familia del zócalo. Debe ser 'udp4' o 'udp6'. Requerido.
opciones.reuseAddr	booleano	FALSO	verdadero	Cuando es verdadero, socket.bind() reutilizará la dirección, incluso si otro proceso ya ha vinculado un socket a ella. Valor predeterminado: falso.
opciones.ipv6Sólo	booleano	FALSO	verdadero	Configurar ipv6Only en verdadero deshabilitará el soporte de doble pila, es decir, vincular a la dirección :: no hará que 0.0.0.0 esté vinculado. Valor predeterminado: falso.
opciones.recvBufferSize	número		verdadero	Establece el valor del socket SO_RCVBUF.
opciones.sendBufferSize	número		verdadero	Establece el valor del socket SO_SNDBUF.
opciones.señal	Abortar señal		verdadero	Una AbortSignal que puede usarse para cerrar un socket.
llamar de vuelta	función		verdadero	Adjunto como oyente para eventos de 'mensajes'. Opcional.

Valor de retorno	Tipo	Descripción
No especificado	Enchufe

Socket (extiende EventEmitter )

Se crean nuevas instancias de dgram.Socket usando dgram.createSocket(). La nueva palabra clave no se debe utilizar para crear instancias de dgram.Socket.

bind(port, address, callback)

Documentos externos: https://nodejs.org/api/dgram.html#socketbindport-address-callback

Escuche los mensajes de datagramas en un puerto con nombre y una dirección opcional. Si no se especifica la dirección, el sistema operativo intentará escuchar en todas las direcciones. Una vez que se completa el enlace, se emite un evento de 'escucha' y se llama a la función de devolución de llamada opcional.

Si el enlace falla, se emite un evento de "error".

Argumento	Tipo	Por defecto	Opcional	Descripción
puerto	número		FALSO	El puerto para escuchar mensajes
DIRECCIÓN	cadena		FALSO	La dirección a la que vincularse (0.0.0.0)
llamar de vuelta	función		FALSO	Sin parámetros. Se llama cuando se completa el enlace.

connect(port, host, connectListener)

Documentos externos: https://nodejs.org/api/dgram.html#socketconnectport-address-callback

Asocia el dgram.Socket a una dirección y puerto remotos. Cada mensaje enviado por este identificador se envía automáticamente a ese destino. Además, el socket solo recibirá mensajes de ese par remoto. Intentar llamar a connect() en un socket ya conectado dará como resultado una excepción ERR_SOCKET_DGRAM_IS_CONNECTED. Si no se proporciona la dirección, se utilizará de forma predeterminada '127.0.0.1' (para sockets udp4) o '::1' (para sockets udp6). Una vez que se completa la conexión, se emite un evento de 'conexión' y se llama a la función de devolución de llamada opcional. En caso de falla, se llama a la devolución de llamada o, en su defecto, se emite un evento de 'error'.

Argumento	Tipo	Por defecto	Opcional	Descripción
puerto	número		FALSO	Puerto al que debe conectarse el cliente.
anfitrión	cadena		verdadero	Host al que el cliente debe conectarse.
conectar oyente	función		verdadero	Parámetro común de los métodos socket.connect(). Se agregará como oyente para el evento 'conectar' una vez.

disconnect()

Documentos externos: https://nodejs.org/api/dgram.html#socketdisconnect

Una función síncrona que desasocia un dgram.Socket conectado de su dirección remota. Intentar llamar aconnect() en un socket no vinculado o ya desconectado dará como resultado una excepción ERR_SOCKET_DGRAM_NOT_CONNECTED.

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

Documentos externos: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback

Transmite un datagrama en el socket. Para sockets sin conexión, se deben especificar el puerto y la dirección de destino. Los sockets conectados, por otro lado, utilizarán su punto final remoto asociado, por lo que no se deben configurar los argumentos de puerto y dirección.

El argumento msg contiene el mensaje que se enviará. Dependiendo de su tipo, se pueden aplicar diferentes comportamientos. Si msg es un Buffer, cualquier TypedArray o DataView, el desplazamiento y la longitud especifican el desplazamiento dentro del Buffer donde comienza el mensaje y el número de bytes en el mensaje, respectivamente. Si msg es una cadena, se convierte automáticamente en un búfer con codificación 'utf8'. Con mensajes que contienen caracteres de varios bytes, el desplazamiento y la longitud se calcularán con respecto a la longitud del byte y no a la posición del carácter. Si msg es una matriz, no se deben especificar el desplazamiento ni la longitud.

El argumento de la dirección es una cadena. Si el valor de la dirección es un nombre de host, se utilizará DNS para resolver la dirección del host. Si no se proporciona la dirección o se anula de otro modo, se utilizará '127.0.0.1' (para sockets udp4) o '::1' (para sockets udp6) de forma predeterminada.

Si el socket no se ha vinculado previamente con una llamada para vincular, se le asigna un número de puerto aleatorio y se vincula a la dirección de "todas las interfaces" ('0.0.0.0' para sockets udp4, '::0' para sockets udp6 .)

Se puede especificar una función de devolución de llamada opcional como forma de informar errores de DNS o para determinar cuándo es seguro reutilizar el objeto buf. Las búsquedas de DNS retrasan el tiempo de envío durante al menos un tic del bucle de eventos de Node.js.

La única forma de saber con seguridad que el datagrama se ha enviado es mediante una devolución de llamada. Si se produce un error y se realiza una devolución de llamada, el error se pasará como primer argumento de la devolución de llamada. Si no se proporciona una devolución de llamada, el error se emite como un evento de "error" en el objeto socket.

El desplazamiento y la longitud son opcionales, pero se deben configurar ambos si se utiliza alguno de ellos. Solo se admiten cuando el primer argumento es un Buffer, un TypedArray o un DataView.

Argumento	Tipo	Por defecto	Opcional	Descripción
mensaje	Búfer | Matriz mecanografiada | Vista de datos | cadena | Formación		FALSO	Mensaje a enviar.
compensar	entero		verdadero	Desplazamiento en el búfer donde comienza el mensaje.
longitud	entero		verdadero	Número de bytes en el mensaje.
puerto	entero		verdadero	Puerto de destino.
DIRECCIÓN	cadena		verdadero	Nombre de host de destino o dirección IP.
llamar de vuelta	Función		verdadero	Llamado cuando el mensaje ha sido enviado.

close(callback)

Documentos externos: https://nodejs.org/api/dgram.html#socketclosecallback

Cierre el socket subyacente y deje de escuchar los datos que contiene. Si se proporciona una devolución de llamada, se agrega como escucha para el evento de "cierre".

Argumento	Tipo	Por defecto	Opcional	Descripción
llamar de vuelta	función		verdadero	Se llama cuando se completa la conexión o en caso de error.

address()

Documentos externos: https://nodejs.org/api/dgram.html#socketaddress

Devuelve un objeto que contiene la información de dirección de un socket. Para sockets UDP, este objeto contendrá propiedades de dirección, familia y puerto.

Este método genera EBADF si se llama en un socket independiente.

Valor de retorno	Tipo	Descripción
socketInfo	Objeto	Información sobre el enchufe local.
socketInfo.dirección	cadena	La dirección IP del socket.
socketInfo.puerto	cadena	El puerto del zócalo
socketInfo.familia	cadena	La familia IP del socket.

remoteAddress()

Documentos externos: https://nodejs.org/api/dgram.html#socketremoteaddress

Devuelve un objeto que contiene la dirección, la familia y el puerto del punto final remoto. Este método genera una excepción ERR_SOCKET_DGRAM_NOT_CONNECTED si el socket no está conectado.

Valor de retorno	Tipo	Descripción
socketInfo	Objeto	Información sobre el enchufe remoto
socketInfo.dirección	cadena	La dirección IP del socket.
socketInfo.puerto	cadena	El puerto del zócalo
socketInfo.familia	cadena	La familia IP del socket.

setRecvBufferSize(size)

Documentos externos: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize

Establece la opción de socket SO_RCVBUF. Establece el búfer de recepción de socket máximo en bytes.

Argumento	Tipo	Por defecto	Opcional	Descripción
tamaño	número		FALSO	El tamaño del nuevo búfer de recepción.

setSendBufferSize(size)

Documentos externos: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize

Establece la opción de socket SO_SNDBUF. Establece el búfer de envío de socket máximo en bytes.

Argumento	Tipo	Por defecto	Opcional	Descripción
tamaño	número		FALSO	El tamaño del nuevo búfer de envío.

getRecvBufferSize()

Documentos externos: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize

getSendBufferSize()

Documentos externos: https://nodejs.org/api/dgram.html#socketgetsendbuffersize

Valor de retorno	Tipo	Descripción
No especificado	número	el tamaño del búfer de envío del socket SO_SNDBUF en bytes.

DNS

Este módulo permite la resolución de nombres. Por ejemplo, utilícelo para buscar direcciones IP de nombres de host. Aunque recibe su nombre del Sistema de nombres de dominio (DNS), no siempre utiliza el protocolo DNS para las búsquedas. dns.lookup() utiliza las instalaciones del sistema operativo para realizar la resolución de nombres. Es posible que no necesite realizar ninguna comunicación de red. Para realizar la resolución de nombres como lo hacen otras aplicaciones en el mismo sistema, utilice dns.lookup().

lookup(hostname, opts, cb)

Documentos externos: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback

Resuelve un nombre de host (por ejemplo, example.org ) en el primer registro A (IPv4) o AAAA (IPv6) encontrado. Todas las propiedades de opción son opcionales. Si las opciones son un número entero, entonces debe ser 4 o 6; si las opciones son 0 o no se proporcionan, se devuelven las direcciones IPv4 e IPv6 si se encuentran.

Desde el sitio web de node.js...

Con la opción all configurada en verdadero, los argumentos para la devolución de llamada cambian a (err, direcciones), siendo las direcciones una matriz de objetos con las propiedades dirección y familia.

En caso de error, err es un objeto de error, donde err.code es el código de error. Tenga en cuenta que err.code se establecerá en 'ENOTFOUND' no solo cuando el nombre de host no exista sino también cuando la búsqueda falle de otras maneras, como por ejemplo, si no hay descriptores de archivos disponibles. dns.lookup() no necesariamente tiene nada que ver con el protocolo DNS. La implementación utiliza una función del sistema operativo que puede asociar nombres con direcciones y viceversa. Esta implementación puede tener consecuencias sutiles pero importantes en el comportamiento de cualquier programa Node.js. Tómese un tiempo para consultar la sección Consideraciones de implementación antes de usar dns.lookup().

Argumento	Tipo	Por defecto	Opcional	Descripción
nombre de host	cadena		FALSO	El nombre del host a resolver.
opta	Objeto		verdadero	Un objeto de opciones.
opciones.familia	número | cadena	0	FALSO	La familia discográfica. Debe ser 4, 6 o 0. Por motivos de compatibilidad con versiones anteriores, 'IPv4' e 'IPv6' se interpretan como 4 y 6 respectivamente. El valor 0 indica que se devuelven direcciones IPv4 e IPv6. Predeterminado: 0.
cb	función		FALSO	La función a llamar después de que se complete el método.

DNS.promesas

Este módulo permite la resolución de nombres. Por ejemplo, utilícelo para buscar direcciones IP de nombres de host. Aunque recibe su nombre del Sistema de nombres de dominio (DNS), no siempre utiliza el protocolo DNS para las búsquedas. dns.lookup() utiliza las instalaciones del sistema operativo para realizar la resolución de nombres. Es posible que no necesite realizar ninguna comunicación de red. Para realizar la resolución de nombres como lo hacen otras aplicaciones en el mismo sistema, utilice dns.lookup().

lookup(hostname, opts)

Documentos externos: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

Argumento	Tipo	Por defecto	Opcional	Descripción
nombre de host	cadena		FALSO	El nombre del host a resolver.
opta	Objeto		verdadero	Un objeto de opciones.
opciones.familia	número | cadena	0	FALSO	La familia discográfica. Debe ser 4, 6 o 0. Por motivos de compatibilidad con versiones anteriores, 'IPv4' e 'IPv6' se interpretan como 4 y 6 respectivamente. El valor 0 indica que se devuelven direcciones IPv4 e IPv6. Predeterminado: 0.

Valor de retorno	Tipo	Descripción
No especificado	Promesa

Sistema de archivos

Este módulo permite interactuar con el sistema de archivos de una manera modelada según las funciones POSIX estándar.

Application Sandbox restringe el acceso al sistema de archivos. Consulte la documentación de Application Sandbox para obtener más información: https://sockets.sh/guides/#working-with-the-file-system-on-ios

Para utilizar las API basadas en promesas:

 import * as fs from '@socketsupply/socket-api/fs/promises.js' ;

Para utilizar las API de devolución de llamada y asincrónicas:

 import * as fs from '@socketsupply/socket-api/fs/index.js' ; 

access(path, mode , callback)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback

Verifica de forma asincrónica el acceso a un archivo para un modo determinado y llama callback en caso de éxito o error.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
modo	cadena	F_OK(0)	verdadero
llamar de vuelta	función (errar, fd)		FALSO

chmod(path, mode, callback)

Documentos externos: https://nodejs.org/api/fs.html#fschmodpath-mode-callback

Cambia asincrónicamente los permisos de un archivo. No se dan más argumentos que una posible excepción a la devolución de llamada de finalización.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
modo	número		FALSO
llamar de vuelta	función (errar)		FALSO

close(fd, callback)

Cierre asincrónicamente un descriptor de archivo que solicite callback en caso de éxito o error.

Argumento	Tipo	Por defecto	Opcional	Descripción
fd	número		FALSO
llamar de vuelta	función (errar)		verdadero

copyFile()

Esta es una FunctionDeclaration denominada copyFile en fs/index.js , se exporta pero no está documentada.

createReadStream(path, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero

Valor de retorno	Tipo	Descripción
No especificado	fs.ReadStream

createWriteStream(path, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero

Valor de retorno	Tipo	Descripción
No especificado	fs.WriteStream

fstat(fd, options, callback)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback

Invoca la devolución de llamada con <fs.Stats> para el descriptor de archivo. Consulte la documentación de POSIX fstat(2) para obtener más detalles.

Argumento	Tipo	Por defecto	Opcional	Descripción
fd	número		FALSO	Un descriptor de archivo.
opciones	Objeto		verdadero	Un objeto de opciones.
llamar de vuelta	función		FALSO	La función a llamar después de la finalización.

open(path, flags , mode , callback)

Abra de forma asincrónica un archivo que solicite callback en caso de éxito o error.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
banderas	cadena	r	verdadero
modo	cadena	0o666	verdadero
llamar de vuelta	función (errar, fd)		FALSO

opendir(path, options, callback)

Abra de forma asincrónica un directorio que solicite callback en caso de éxito o error.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	Objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.con tipos de archivo	booleano	FALSO	verdadero
llamar de vuelta	función (errar, fd)		FALSO

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

Leer de forma asincrónica desde un descriptor de archivo abierto.

Argumento	Tipo	Por defecto	Opcional	Descripción
fd	número		FALSO
buffer	objeto | Búfer | Matriz mecanografiada		FALSO	El búfer en el que se escribirán los datos.
compensar	número		FALSO	La posición en el búfer donde escribir los datos.
longitud	número		FALSO	El número de bytes a leer.
posición	número | GrandeInt | nulo		FALSO	Especifica dónde comenzar a leer en el archivo. Si la posición es nula o -1, los datos se leerán desde la posición actual del archivo y se actualizará la posición del archivo. Si la posición es un número entero, la posición del archivo no cambiará.
llamar de vuelta	función (err, bytesRead, buffer)		FALSO

readdir(path, options, callback)

Lea de forma asincrónica todas las entradas en un directorio.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.con tipos de archivo	booleano	FALSO	verdadero
llamar de vuelta	función (err, búfer)		FALSO

readFile(path, options, callback)

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL | número		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.flag	cadena	r	verdadero
opciones.señal	Abortar señal		verdadero
llamar de vuelta	función (err, búfer)		FALSO

stat(path, options, callback)

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL | número		FALSO	nombre de archivo o descriptor de archivo
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.flag	cadena	r	verdadero
opciones.señal	Abortar señal		verdadero
llamar de vuelta	función (errar, datos)		FALSO

writeFile(path, data, options, callback)

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL | número		FALSO	nombre de archivo o descriptor de archivo
datos	cadena | Búfer | Matriz mecanografiada | Vista de datos | objeto		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.modo	cadena	0o666	verdadero
opciones.flag	cadena	w	verdadero
opciones.señal	Abortar señal		verdadero
llamar de vuelta	función (errar)		FALSO

writev()

Esta es una FunctionDeclaration llamada writev en fs/index.js , se exporta pero no está documentada.

FS.promesas

access(path, mode, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode

Verifique de forma asincrónica el acceso a un archivo.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
modo	cadena		verdadero
opciones	objeto		verdadero

chmod(path, mode)

Documentos externos: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
modo	número		FALSO

Valor de retorno	Tipo	Descripción
No especificado	Promesa

mkdir(path, options)

Crea un directorio de forma asincrónica.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	Cadena		FALSO	El camino para crear
opciones	Objeto		FALSO	El argumento de opciones opcionales puede ser un número entero que especifica el modo (permiso y bits fijos) o un objeto con una propiedad de modo y una propiedad recursiva que indica si se deben crear directorios principales. Llamar a fs.mkdir() cuando la ruta es un directorio que existe da como resultado un error solo cuando recursivo es falso.

Valor de retorno	Tipo	Descripción
No especificado	prima	Si tiene éxito, se cumple con indefinido si recursivo es falso, o la primera ruta de directorio creada si recursivo es verdadero.

open(path, flags, mode)

Documentos externos: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode

Abra un archivo de forma asincrónica.

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
banderas	cadena		FALSO	predeterminado: 'r'
modo	cadena		FALSO	predeterminado: 0o666

Valor de retorno	Tipo	Descripción
No especificado	Promesa

opendir(path, options)

Documentos externos: https://nodejs.org/api/fs.html#fspromisesopendirpath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.bufferSize	número	32	verdadero

Valor de retorno	Tipo	Descripción
No especificado	Promesa<Sistema de archivos,Dir>

readdir(path, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena	utf8	verdadero
opciones.con tipos de archivo	booleano	FALSO	verdadero

readFile(path, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena | nulo	nulo	verdadero
opciones.flag	cadena	r	verdadero
opciones.señal	Abortar señal		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Promesa<búfer	cadena>

stat(path, options)

Documentos externos: https://nodejs.org/api/fs.html#fspromisesstatpath-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL		FALSO
opciones	objeto		verdadero
opciones.bigint	booleano	FALSO	verdadero

Valor de retorno	Tipo	Descripción
No especificado	Promesa

writeFile(path, data, options)

Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options

Argumento	Tipo	Por defecto	Opcional	Descripción
camino	cadena | Búfer | URL | Mango de archivo		FALSO	nombre de archivo o FileHandle
datos	cadena | Búfer | Matriz | Vista de datos | Matriz mecanografiada | Arroyo		FALSO
opciones	objeto		verdadero
opciones.codificación	cadena | nulo	utf8	FALSO
opciones.modo	número	0o666	FALSO
opciones.flag	cadena	w	FALSO
opciones.señal	Abortar señal		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Promesa

FS.Stream

DEFAULT_STREAM_HIGH_WATER_MARK

Esta es una VariableDeclaration denominada DEFAULT_STREAM_HIGH_WATER_MARK en fs/stream.js , está exportada pero no documentada.

ReadStream (extiende Readable )

Una secuencia Readable para un FileHandle .

constructor()

Constructor de clase ReadStream

setHandle(handle)

Establece el identificador de archivo para ReadStream.

Argumento	Tipo	Por defecto	Opcional	Descripción
manejar	Mango de archivo		FALSO

highWaterMark()

El tamaño máximo de búfer para ReadStream.

path()

Ruta relativa o absoluta del FileHandle subyacente.

pending()

true si la transmisión está en estado pendiente.

emit()

Maneja la configuración shouldEmitClose desde options.emitClose en el constructor.

WriteStream (extiende Writable )

Una secuencia Writable para un FileHandle .

constructor()

Constructor de clase WriteStream

setHandle(handle)

Establece el identificador de archivo para WriteStream.

Argumento	Tipo	Por defecto	Opcional	Descripción
manejar	Mango de archivo		FALSO

highWaterMark()

El tamaño máximo de búfer para Writetream.

path()

Ruta relativa o absoluta del FileHandle subyacente.

pending()

true si la transmisión está en estado pendiente.

emit()

Maneja la configuración shouldEmitClose desde options.emitClose en el constructor.

ArchivoReadStream

Esta es una VariableDeclaration denominada FileReadStream en fs/stream.js , se exporta pero no está documentada.

flujo de escritura de archivos

Esta es una VariableDeclaration denominada FileWriteStream en fs/stream.js , está exportada pero no documentada.

IPC

Esta es una API de bajo nivel que no necesita a menos que esté implementando una biblioteca además de Socket SDK. Una aplicación Socket SDK tiene dos o tres procesos.

• El proceso Render , la interfaz de usuario donde se ejecuta HTML, CSS y JS.
• El proceso Bridge , la fina capa de código que gestiona todo.
• El proceso Main , para aplicaciones que necesitan ejecutar trabajos informáticos más pesados. Y a diferencia del electrón, es opcional.

El proceso Bridge gestiona el proceso Render y Main, y también puede intermediar datos entre ellos.

El proceso de vinculación utiliza entradas y salidas estándar como forma de comunicación. El sistema operativo almacena los datos escritos en el extremo de escritura de la tubería hasta que se leen desde el extremo de lectura de la tubería.

El protocolo IPC utiliza un esquema simple similar a un URI. Los datos se pasan como ArrayBuffers.

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

postMessage()

Esta es una FunctionDeclaration denominada postMessage en ipc.js , se exporta pero no está documentada.

DE ACUERDO

Representa un estado OK de IPC.

ERROR

Representa un estado de ERROR IPC.

SE ACABÓ EL TIEMPO

Tiempo de espera en milisegundos para solicitudes de IPC.

kDebugEnabled

Símbolo de la propiedad ipc.debug.enabled

parseSeq(seq, options)

Analiza seq como valor entero

Argumento	Tipo	Por defecto	Opcional	Descripción
secuencia	cadena | número		FALSO
opciones	objeto		verdadero
opciones.bigint	booleano	FALSO	FALSO

debug(enable)

Si debug.enabled === true , la salida de depuración se imprimirá en la consola.

Argumento	Tipo	Por defecto	Opcional	Descripción
permitir	booleano		FALSO

Valor de retorno	Tipo	Descripción
No especificado	booleano

Message (extiende URL )

Un contenedor para un mensaje IPC basado en un esquema URI ipc:// .

PROTOCOL()

El protocolo esperado para un mensaje IPC.

from(input, params)

Crea una instancia Message a partir de una variedad de entradas.

Argumento	Tipo	Por defecto	Opcional	Descripción
aporte	cadena | URL | Mensaje | Búfer | objeto		FALSO
parámetros	objeto | cadena | Parámetros de búsqueda de URL		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Mensaje

isValidInput(input)

Predicado para determinar si input es válida para construir una nueva instancia Message .

Argumento	Tipo	Por defecto	Opcional	Descripción
aporte	cadena | URL | Mensaje | Búfer | objeto		FALSO

Valor de retorno	Tipo	Descripción
No especificado	booleano

constructor(input)

Constructor de clase de Message .

Argumento	Tipo	Por defecto	Opcional	Descripción
aporte	cadena | URL		FALSO

command()

Nombre del mensaje IPC calculado.

name()

Nombre del mensaje IPC calculado.

id()

Valor id calculado para el comando.

seq()

Valor seq (secuencia) calculado para el comando.

value()

Valor de mensaje calculado potencialmente proporcionado en los parámetros del mensaje. Este valor se decodifica automáticamente, pero no se trata como JSON.

index()

Valor index calculado para el comando que potencialmente hace referencia al índice de ventana al que se refiere el comando o desde el que se origina. Si no se especifica en los parámetros del mensaje, este valor predeterminado es -1 .

json()

Valor calculado analizado como JSON. Este valor es null si el valor no está presente o si es JSON no válido.

params()

Objeto de solo lectura calculado de los parámetros del mensaje.

entries()

Devuelve los parámetros calculados como entradas

Valor de retorno	Tipo	Descripción
No especificado	Matriz<Matriz<cadena,mixta>>

set(key, value)

Establezca un value de parámetro mediante key .

Argumento	Tipo	Por defecto	Opcional	Descripción
llave	cadena		FALSO
valor	mezclado		FALSO

get(key, defaultValue)

Obtenga un valor de parámetro por key .

Argumento	Tipo	Por defecto	Opcional	Descripción
llave	cadena		FALSO
valor predeterminado	mezclado		FALSO

Valor de retorno	Tipo	Descripción
No especificado	mezclado

delete(key)

Eliminar un parámetro por key .

Argumento	Tipo	Por defecto	Opcional	Descripción
llave	cadena		FALSO

Valor de retorno	Tipo	Descripción
No especificado	booleano

keys()

Claves de parámetros calculados.

Valor de retorno	Tipo	Descripción
No especificado	Formación

values()

Valores de parámetros calculados.

Valor de retorno	Tipo	Descripción
No especificado	Formación

has(key)

Predicado para determinar si key del parámetro está presente en los parámetros.

Argumento	Tipo	Por defecto	Opcional	Descripción
llave	cadena		FALSO

Valor de retorno	Tipo	Descripción
No especificado	booleano

toJSON()

Convierte una instancia Message en un objeto JSON simple.

Resultado

Un tipo de resultado utilizado internamente para manejar los valores de resultados de IPC de la capa nativa que tienen el formato { err?, data? } . Las propiedades data y err en este tipo de objeto están en forma de tupla y se puede acceder a ellas en [data?,err?]

from(result, maybeError, maybeSource)

Crea una instancia Result a partir de una entrada que puede ser un objeto como { err?, data? } , una instancia Error o simplemente data .

Argumento	Tipo	Por defecto	Opcional	Descripción
resultado	objeto | Error | mezclado		verdadero
tal vezError	Error		verdadero
tal vezFuente	cadena		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Resultado

constructor(err , data , source )

Constructor de clase Result .

Argumento	Tipo	Por defecto	Opcional	Descripción
errar	Error	nulo	verdadero
datos	objeto	nulo	verdadero
fuente	cadena	indefinido	verdadero

length()

Longitud del resultado calculada.

ready()

Espera a que la capa IPC nativa esté lista y expuesta en el objeto de ventana global.

sendSync(command, params)

Envía un comando IPC sincrónico a través de XHR y devuelve un Result en caso de éxito o error.

Argumento	Tipo	Por defecto	Opcional	Descripción
dominio	cadena		FALSO
parámetros	objeto | cadena		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Resultado

emit(name, value, target , options)

Emite el evento que se enviará al objeto window .

Argumento	Tipo	Por defecto	Opcional	Descripción
nombre	cadena		FALSO
valor	Mezclado		FALSO
objetivo	Objetivo del evento	ventana	verdadero
opciones	Objeto		verdadero

resolve(seq, value)

Resuelve una solicitud por seq con valor posible.

Argumento	Tipo	Por defecto	Opcional	Descripción
secuencia	cadena		FALSO
valor	Mezclado		FALSO

send(command, value)

Envía una solicitud de comando IPC asíncrona con parámetros.

Argumento	Tipo	Por defecto	Opcional	Descripción
dominio	cadena		FALSO
valor	Mezclado		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Promesa

write(command, params, buffer, options)

Envía una solicitud de comando IPC asíncrona con parámetros y bytes almacenados en el búfer.

Argumento	Tipo	Por defecto	Opcional	Descripción
dominio	cadena		FALSO
parámetros	objeto		verdadero
buffer	Búfer | TipoArray | búfer de matriz | cadena | Formación		verdadero
opciones	objeto		verdadero

request(command, params, options)

Envía una solicitud de comando IPC asíncrona con parámetros que solicitan una respuesta con bytes almacenados en el búfer.

Argumento	Tipo	Por defecto	Opcional	Descripción
dominio	cadena		FALSO
parámetros	objeto		verdadero
opciones	objeto		verdadero

createBinding(domain, ctx)

Fábrica para crear una API IPC basada en proxy.

Argumento	Tipo	Por defecto	Opcional	Descripción
dominio	cadena		FALSO
ctx	función | objeto		verdadero
ctx.predeterminado	cadena		verdadero

Valor de retorno	Tipo	Descripción
No especificado	Apoderado

SO

Este módulo proporciona información normalizada del sistema de todos los principales sistemas operativos.

arch()

Esta es una FunctionDeclaration denominada arch en os.js , se exporta pero no está documentada.

networkInterfaces()

Esta es una FunctionDeclaration denominada networkInterfaces en os.js , se exporta pero no está documentada.

platform()

Esta es una FunctionDeclaration denominada platform en os.js , se exporta pero no está documentada.

type()

Esta es una FunctionDeclaration denominada type en os.js , se exporta pero no está documentada.

isWindows()

Esta es una FunctionDeclaration llamada isWindows en os.js , se exporta pero no está documentada.

tmpdir()

Esta es una FunctionDeclaration llamada tmpdir en os.js , se exporta pero no está documentada.

fin de vida

Esta es una VariableDeclaration denominada EOL en os.js , se exporta pero no está documentada.

Camino

Camino

Esta es una ClassDeclaration denominada Path en path/path.js , se exporta pero no está documentada.

cwd(opts)

Calcula el directorio de trabajo actual para una ruta

Argumento	Tipo	Por defecto	Opcional	Descripción
opta	objeto		verdadero
opts.posix Establecer en true para forzar la ruta de estilo POSIX	booleano		verdadero

constructor(opts)

Constructor de clase Path .

Argumento	Tipo	Por defecto	Opcional	Descripción
opta	objeto		verdadero
opciones.root	cadena		verdadero
opciones.base	cadena		verdadero
opciones.nombre	cadena		verdadero
opciones.dir	cadena		verdadero
opciones.ext	cadena		verdadero

resolve()

normalize()

Proceso

homedir()

Valor de retorno	Tipo	Descripción
No especificado	cadena	El directorio de inicio del usuario actual.

exit(code)

Argumento	Tipo	Por defecto	Opcional	Descripción
código	número	0	verdadero	El código de salida. Predeterminado: 0.

Tiempo de ejecución

Proporciona métodos específicos del tiempo de ejecución.

ventana actual

Esta es una VariableDeclaration denominada currentWindow en runtime.js , se exporta pero no está documentada.

depurar

Esta es una VariableDeclaration denominada debug en runtime.js , se exporta pero no está documentada.

configuración

Esta es una VariableDeclaration denominada config en runtime.js , se exporta pero no está documentada.

send()

Esta es una FunctionDeclaration denominada send en runtime.js , se exporta pero no está documentada.

getWindows()

Esta es una FunctionDeclaration llamada getWindows en runtime.js , se exporta pero no está documentada.

openExternal()

Esta es una FunctionDeclaration denominada openExternal en runtime.js , se exporta pero no está documentada.

exit(options)

Sale del proceso de backend y luego sale del proceso de renderizado; el código de salida utilizado es el código de salida final del sistema operativo.

Argumento	Tipo	Por defecto	Opcional	Descripción
opciones	objeto		FALSO	un objeto de opciones

Valor de retorno	Tipo	Descripción
No especificado	Promesa

setTitle(options)

Establece el título de la ventana (si corresponde).

Argumento	Tipo	Por defecto	Opcional	Descripción
opciones	objeto		FALSO	un objeto de opciones

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

inspect()

Esta es una FunctionDeclaration denominada inspect en runtime.js , se exporta pero no está documentada.

show(opts)

Argumento	Tipo	Por defecto	Opcional	Descripción
opta	objeto		FALSO	un objeto de opciones

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

hide(opts)

Argumento	Tipo	Por defecto	Opcional	Descripción
opta	objeto		FALSO	un objeto de opciones

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

navigate(opts)

Argumento	Tipo	Por defecto	Opcional	Descripción
opta	objeto		FALSO	un objeto de opciones
ventanas.opts	número	ventana actual	FALSO	el índice de la ventana
opciones.url	número		FALSO	la ruta al archivo HTML para cargar en la ventana

Valor de retorno	Tipo	Descripción
No especificado	Promesa<ipc.Resultado>

setWindowBackgroundColor()

Esta es una FunctionDeclaration denominada setWindowBackgroundColor en runtime.js , se exporta pero no está documentada.

setContextMenu(options)

Abre un menú contextual nativo.

Argumento	Tipo	Por defecto	Opcional	Descripción
opciones	objeto		FALSO	un objeto de opciones

Valor de retorno	Tipo	Descripción
No especificado	Promesa

setSystemMenuItemEnabled()

Esta es una FunctionDeclaration denominada setSystemMenuItemEnabled en runtime.js , está exportada pero no documentada.

setSystemMenu(options)

Configure el menú nativo de la aplicación.

Socket Runtime proporciona un DSL minimalista que facilita la creación de menús contextuales y sistemas nativos multiplataforma.

Los menús se crean en tiempo de ejecución. Se pueden crear desde el proceso Principal o Renderizado. Se pueden recrear instantáneamente llamando al método setSystemMenu .

El método toma una cuerda. A continuación se muestra un ejemplo de menú. El punto y coma es significativo indica el final del menú. Utilice un guión bajo cuando no haya una tecla de aceleración. Los modificadores son opcionales. Y las opciones de menú del sistema operativo más conocidas, como el menú de edición, obtendrán automáticamente aceleradores que no es necesario especificar.

 socket . runtime . 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;
` ) 

Separadores

Para crear un separador, utilice tres guiones --- .

Modificadores del acelerador

Los modificadores del acelerador se utilizan como indicadores visuales, pero no tienen un impacto material ya que la combinación de teclas real se realiza en el detector de eventos.

Una letra mayúscula implica que el acelerador se modifica con la tecla Shift .

Los aceleradores adicionales son Meta , Control , Option , cada uno separado por comas. Si uno no es aplicable para una plataforma, simplemente se ignorará.

En MacOS Meta es lo mismo que Command .

Artículos deshabilitados

Si desea deshabilitar un elemento del menú, simplemente anteponga el elemento con el símbolo ! personaje. Esto hará que el elemento aparezca deshabilitado cuando se muestre el menú del sistema.

Submenús

Creemos que los menús anidados son un antipatrón. No los usamos. Si tiene un argumento sólido a favor de ellos y una solicitud de extracción muy simple que los haga funcionar, podemos considerarlos.

Manejo de eventos

Cuando se activa un elemento de menú, genera el evento menuItemSelected en el código de front-end, luego puede comunicarse con su código de backend si lo desea desde allí.

Por ejemplo, si el elemento Apple está seleccionado en el menú Other ...

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

Argumento	Tipo	Por defecto	Opcional	Descripción
opciones	objeto		FALSO	un objeto de opciones
opciones.valor	cadena		FALSO	el diseño del menú
opciones.index	número		FALSO	la ventana de destino (si corresponde)

Valor de retorno	Tipo	Descripción
No especificado	Promesa

reload()

Esta es una FunctionDeclaration denominada reload en runtime.js , se exporta pero no está documentada.

Arroyo