socket api
1.0.0
Uma API multiplataforma de alto nível para Bluetooth Pub-Sub
Bluetooth (estende EventEmitter )Crie uma instância de um serviço Bluetooth.
constructor(serviceId) construtor é um exemplo de propriedade definida como true Cria um novo serviço com pares chave-valor
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| ID de serviço | corda | falso | Dado um valor padrão para determinar o tipo |
start()Inicie o serviço Bluetooth.
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
subscribe(id )Comece a procurar valores publicados que correspondam a um UUID conhecido. Uma vez inscrito em um UUID, os eventos que correspondem a esse UUID serão emitidos. Para receber esses eventos você pode adicionar um ouvinte de eventos, por exemplo...
const ble = new Bluetooth ( id )
ble . subscribe ( uuid )
ble . on ( uuid , ( data , details ) => {
// ...do something interesting
} )| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| eu ia | corda | falso | Um UUID bem conhecido |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
publish(id, value)Comece a anunciar um novo valor para um UUID conhecido
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| eu ia | corda | falso | Um UUID bem conhecido | |
| valor | corda | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
Documentos externos: https://nodejs.org/api/buffer.html#buffer_class_buffer
O módulo buffer do node.js, para o navegador.
If Buffer.TYPED_ARRAY_SUPPORT : === true Use a implementação Uint8Array (mais rápida) === false Imprima um aviso e recomende usar buffer v4.x que possui uma implementação de objeto (mais compatível, até mesmo IE6)
Os navegadores que suportam matrizes digitadas são IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Relatamos que o navegador não oferece suporte a arrays digitados se eles não puderem ser subclassificados usando proto . O Firefox 4-29 não tem suporte para adicionar novas propriedades ao Uint8Array (Veja: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). O IE 10 não tem suporte para proto e possui uma implementação de array digitada com erros.
If Buffer.TYPED_ARRAY_SUPPORT : === true Use a implementação Uint8Array (mais rápida) === false Imprima um aviso e recomende usar buffer v4.x que possui uma implementação de objeto (mais compatível, até mesmo IE6)
Os navegadores que suportam matrizes digitadas são IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Relatamos que o navegador não oferece suporte a arrays digitados se eles não puderem ser subclassificados usando proto . O Firefox 4-29 não tem suporte para adicionar novas propriedades ao Uint8Array (Veja: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). O IE 10 não tem suporte para proto e possui uma implementação de array digitada com erros.
If Buffer.TYPED_ARRAY_SUPPORT : === true Use a implementação Uint8Array (mais rápida) === false Imprima um aviso e recomende usar buffer v4.x que possui uma implementação de objeto (mais compatível, até mesmo IE6)
Os navegadores que suportam matrizes digitadas são IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Relatamos que o navegador não oferece suporte a arrays digitados se eles não puderem ser subclassificados usando proto . O Firefox 4-29 não tem suporte para adicionar novas propriedades ao Uint8Array (Veja: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). O IE 10 não tem suporte para proto e possui uma implementação de array digitada com erros.
If Buffer.TYPED_ARRAY_SUPPORT : === true Use a implementação Uint8Array (mais rápida) === false Imprima um aviso e recomende usar buffer v4.x que possui uma implementação de objeto (mais compatível, até mesmo IE6)
Os navegadores que suportam matrizes digitadas são IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Relatamos que o navegador não oferece suporte a arrays digitados se eles não puderem ser subclassificados usando proto . O Firefox 4-29 não tem suporte para adicionar novas propriedades ao Uint8Array (Veja: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). O IE 10 não tem suporte para proto e possui uma implementação de array digitada com erros.
O construtor Buffer retorna instâncias de Uint8Array que tiveram seu protótipo alterado para Buffer.prototype . Além disso, Buffer é uma subclasse de Uint8Array , portanto, as instâncias retornadas terão todos os métodos Buffer do nó e os métodos Uint8Array . A notação de colchetes funciona conforme o esperado - retorna um único octeto.
O protótipo Uint8Array permanece inalterado.
Funcionalmente equivalente a Buffer(arg, encoding) mas lança um TypeError se o valor for um número. Buffer.from(str[, codificação]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, comprimento]])
Funcionalmente equivalente a Buffer(arg, encoding) mas lança um TypeError se o valor for um número. Buffer.from(str[, codificação]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, comprimento]])
Funcionalmente equivalente a Buffer(arg, encoding) mas lança um TypeError se o valor for um número. Buffer.from(str[, codificação]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, comprimento]])
Funcionalmente equivalente a Buffer(arg, encoding) mas lança um TypeError se o valor for um número. Buffer.from(str[, codificação]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, comprimento]])
Cria uma nova instância de Buffer preenchida. alocar(tamanho[, preencher[, codificação]])
Cria uma nova instância de Buffer preenchida. alocar(tamanho[, preencher[, codificação]])
Cria uma nova instância de Buffer preenchida. alocar(tamanho[, preencher[, codificação]])
Cria uma nova instância de Buffer preenchida. alocar(tamanho[, preencher[, codificação]])
Equivalente a Buffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a Buffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a Buffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a Buffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a SlowBuffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a SlowBuffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a SlowBuffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Equivalente a SlowBuffer(num), por padrão cria uma instância de Buffer preenchida com zeros.
Alguns métodos de alto nível em torno da API crypto.subtle para obter bytes aleatórios e hash.
API WebCrypto
getRandomValues(buffer)Documentos externos: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
Gere valores aleatórios criptograficamente fortes no buffer
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| buffer | TypedArray | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | TypedArray |
Tamanho total máximo de bytes aleatórios por página
Tamanho total máximo para bytes aleatórios.
Quantidade total máxima de bytes alocados por página (máximo/cota)
randomBytes(size) Gere bytes aleatórios size .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| tamanho | número | falso | O número de bytes a serem gerados. O tamanho não deve ser maior que 2**31 - 1. |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Tampão | Uma promessa que é resolvida com uma instância de socket.Buffer com bytes aleatórios. |
createDigest(algorithm, message)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| algoritmo | corda | falso | SHA-1 | |
| mensagem | Tampão | TypedArray | Visualização de dados | falso | Uma instância de socket.Buffer, TypedArray ou Dataview. |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa | Uma promessa que resolve com uma instância de socket.Buffer com o hash. |
Este módulo fornece uma implementação de soquetes de datagramas UDP. Ele (ainda) não fornece nenhum dos métodos ou propriedades de multicast.
ERR_SOCKET_ALREADY_BOUND (estende SocketError )Lançado quando um soquete já está vinculado.
ERR_SOCKET_DGRAM_IS_CONNECTED (estende SocketError )Lançado quando o soquete já está conectado.
ERR_SOCKET_DGRAM_NOT_CONNECTED (estende SocketError )Lançado quando o soquete não está conectado.
ERR_SOCKET_DGRAM_NOT_RUNNING (estende SocketError )Lançado quando o soquete não está em execução (não vinculado ou conectado).
ERR_SOCKET_BAD_TYPE (estende TypeError )Lançado quando um tipo de soquete inválido é usado em um argumento.
ERR_SOCKET_BAD_PORT (estende RangeError )Lançado quando uma porta incorreta é fornecida.
createSocket(options, callback) Cria uma instância Socket . se ()
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opções | corda | Objeto | falso | uma string ('udp4' ou 'udp6') ou um objeto de opções | |
| opções.tipo | corda | verdadeiro | A família do soquete. Deve ser 'udp4' ou 'udp6'. Obrigatório. | |
| opções.reuseAddr | booleano | falso | verdadeiro | Quando true, socket.bind() reutilizará o endereço, mesmo que outro processo já tenha vinculado um soquete a ele. Padrão: falso. |
| opções.ipv6Only | booleano | falso | verdadeiro | Definir ipv6Only como true desativará o suporte de pilha dupla, ou seja, a ligação ao endereço :: não fará com que 0.0.0.0 seja vinculado. Padrão: falso. |
| opções.recvBufferSize | número | verdadeiro | Define o valor do soquete SO_RCVBUF. | |
| opções.sendBufferSize | número | verdadeiro | Define o valor do soquete SO_SNDBUF. | |
| opções.sinal | Abortar sinal | verdadeiro | Um AbortSignal que pode ser usado para fechar um soquete. | |
| ligar de volta | função | verdadeiro | Anexado como ouvinte para eventos de 'mensagem'. Opcional. |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Soquete |
Socket (estende EventEmitter )Novas instâncias de dgram.Socket são criadas usando dgram.createSocket(). A palavra-chave new não deve ser usada para criar instâncias dgram.Socket.
bind(port, address, callback)Documentos externos: https://nodejs.org/api/dgram.html#socketbindport-address-callback
Escute mensagens de datagrama em uma porta nomeada e endereço opcional. Se o endereço não for especificado, o sistema operacional tentará escutar em todos os endereços. Assim que a ligação for concluída, um evento de 'escuta' será emitido e a função de retorno de chamada opcional será chamada.
Se a ligação falhar, um evento de 'erro' será emitido.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| porta | número | falso | A porta para escutar mensagens | |
| endereço | corda | falso | O endereço ao qual vincular (0.0.0.0) | |
| ligar de volta | função | falso | Sem parâmetros. Chamado quando a vinculação é concluída. |
connect(port, host, connectListener)Documentos externos: https://nodejs.org/api/dgram.html#socketconnectport-address-callback
Associa o dgram.Socket a um endereço e porta remotos. Cada mensagem enviada por esse identificador é enviada automaticamente para esse destino. Além disso, o soquete receberá apenas mensagens desse ponto remoto. Tentar chamar connect() em um soquete já conectado resultará em uma exceção ERR_SOCKET_DGRAM_IS_CONNECTED. Se o endereço não for fornecido, '127.0.0.1' (para soquetes udp4) ou '::1' (para soquetes udp6) será usado por padrão. Assim que a conexão for concluída, um evento 'connect' será emitido e a função de retorno de chamada opcional será chamada. Em caso de falha, o callback é chamado ou, na sua falta, é emitido um evento de 'erro'.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| porta | número | falso | Porta à qual o cliente deve se conectar. | |
| hospedar | corda | verdadeiro | Host ao qual o cliente deve se conectar. | |
| conectarListener | função | verdadeiro | Parâmetro comum dos métodos socket.connect(). Será adicionado como ouvinte do evento 'connect' uma vez. |
disconnect()Documentos externos: https://nodejs.org/api/dgram.html#socketdisconnect
Uma função síncrona que desassocia um dgram.Socket conectado de seu endereço remoto. Tentar chamar desconectar() em um soquete não vinculado ou já desconectado resultará em uma exceção 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 um datagrama no soquete. Para soquetes sem conexão, a porta e o endereço de destino devem ser especificados. Os soquetes conectados, por outro lado, usarão seu terminal remoto associado, portanto os argumentos de porta e endereço não devem ser definidos.
O argumento msg contém a mensagem a ser enviada. Dependendo do tipo, um comportamento diferente pode ser aplicado. Se msg for um Buffer, qualquer TypedArray ou DataView, o deslocamento e o comprimento especificam o deslocamento dentro do Buffer onde a mensagem começa e o número de bytes na mensagem, respectivamente. Se msg for uma String, ela será automaticamente convertida em um Buffer com codificação 'utf8'. Com mensagens que contêm caracteres multibyte, o deslocamento e o comprimento serão calculados em relação ao comprimento do byte e não à posição do caractere. Se msg for uma matriz, o deslocamento e o comprimento não deverão ser especificados.
O argumento do endereço é uma string. Se o valor de endereço for um nome de host, o DNS será usado para resolver o endereço do host. Se o endereço não for fornecido ou for nulo, '127.0.0.1' (para soquetes udp4) ou '::1' (para soquetes udp6) será usado por padrão.
Se o soquete não tiver sido vinculado anteriormente com uma chamada para vincular, o soquete receberá um número de porta aleatório e será vinculado ao endereço "todas as interfaces" ('0.0.0.0' para soquetes udp4, '::0' para soquetes udp6 .)
Uma função de retorno de chamada opcional pode ser especificada como forma de relatar erros de DNS ou para determinar quando é seguro reutilizar o objeto buf. As pesquisas de DNS atrasam o tempo de envio de pelo menos um tick do loop de eventos do Node.js.
A única maneira de saber com certeza se o datagrama foi enviado é usando um retorno de chamada. Se ocorrer um erro e um retorno de chamada for fornecido, o erro será passado como o primeiro argumento do retorno de chamada. Se um retorno de chamada não for fornecido, o erro será emitido como um evento de 'erro' no objeto soquete.
O deslocamento e o comprimento são opcionais, mas ambos devem ser definidos se forem usados. Eles são suportados apenas quando o primeiro argumento é um Buffer, um TypedArray ou um DataView.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| mensagem | Tampão | TypedArray | Visualização de dados | corda | Variedade | falso | Mensagem a ser enviada. | |
| desvio | inteiro | verdadeiro | Deslocamento no buffer onde a mensagem começa. | |
| comprimento | inteiro | verdadeiro | Número de bytes na mensagem. | |
| porta | inteiro | verdadeiro | Porto de destino. | |
| endereço | corda | verdadeiro | Nome do host de destino ou endereço IP. | |
| ligar de volta | Função | verdadeiro | Chamado quando a mensagem foi enviada. |
close(callback)Documentos externos: https://nodejs.org/api/dgram.html#socketclosecallback
Feche o soquete subjacente e pare de ouvir os dados nele. Se um retorno de chamada for fornecido, ele será adicionado como ouvinte para o evento 'close'.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| ligar de volta | função | verdadeiro | Chamado quando a conexão é concluída ou em caso de erro. |
address()Documentos externos: https://nodejs.org/api/dgram.html#socketaddress
Retorna um objeto contendo as informações de endereço de um soquete. Para soquetes UDP, este objeto conterá propriedades de endereço, família e porta.
Este método lança EBADF se for chamado em um soquete não vinculado.
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| soqueteInfo | Objeto | Informações sobre o soquete local |
| socketInfo.address | corda | O endereço IP do soquete |
| socketInfo.port | corda | A porta do soquete |
| socketInfo.família | corda | A família IP do soquete |
remoteAddress()Documentos externos: https://nodejs.org/api/dgram.html#socketremoteaddress
Retorna um objeto contendo o endereço, a família e a porta do terminal remoto. Este método lança uma exceção ERR_SOCKET_DGRAM_NOT_CONNECTED se o soquete não estiver conectado.
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| soqueteInfo | Objeto | Informações sobre o soquete remoto |
| socketInfo.address | corda | O endereço IP do soquete |
| socketInfo.port | corda | A porta do soquete |
| socketInfo.família | corda | A família IP do soquete |
setRecvBufferSize(size)Documentos externos: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize
Define a opção de soquete SO_RCVBUF. Define o buffer máximo de recebimento do soquete em bytes.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| tamanho | número | falso | O tamanho do novo buffer de recebimento |
setSendBufferSize(size)Documentos externos: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize
Define a opção de soquete SO_SNDBUF. Define o buffer máximo de envio do soquete em bytes.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| tamanho | número | falso | O tamanho do novo buffer de envio |
getRecvBufferSize()Documentos externos: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize
getSendBufferSize()Documentos externos: https://nodejs.org/api/dgram.html#socketgetsendbuffersize
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | número | o tamanho do buffer de envio do soquete SO_SNDBUF em bytes. |
Este módulo permite a resolução de nomes. Por exemplo, use-o para procurar endereços IP de nomes de host. Embora nomeado em homenagem ao Sistema de Nomes de Domínio (DNS), ele nem sempre usa o protocolo DNS para pesquisas. dns.lookup() usa os recursos do sistema operacional para realizar a resolução de nomes. Pode não ser necessário realizar nenhuma comunicação de rede. Para realizar a resolução de nomes da mesma forma que outros aplicativos no mesmo sistema, use dns.lookup().
lookup(hostname, opts, cb)Documentos externos: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
Resolve um nome de host (por exemplo, example.org ) no primeiro registro A (IPv4) ou AAAA (IPv6) encontrado. Todas as propriedades de opção são opcionais. Se options for um número inteiro, então deverá ser 4 ou 6 – se options for 0 ou não for fornecido, então os endereços IPv4 e IPv6 serão retornados se encontrados.
No site node.js ...
Com a opção all definida como true, os argumentos para retorno de chamada mudam para (err, endereços), com endereços sendo uma matriz de objetos com as propriedades endereço e família.
Em caso de erro, err é um objeto Error, onde err.code é o código do erro. Tenha em mente que err.code será definido como 'ENOTFOUND' não apenas quando o nome do host não existir, mas também quando a pesquisa falhar de outras maneiras, como nenhum descritor de arquivo disponível. dns.lookup() não tem necessariamente nada a ver com o protocolo DNS. A implementação utiliza um recurso do sistema operacional que pode associar nomes a endereços e vice-versa. Esta implementação pode ter consequências sutis, mas importantes, no comportamento de qualquer programa Node.js. Reserve algum tempo para consultar a seção Considerações de implementação antes de usar dns.lookup().
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| nome do host | corda | falso | O nome do host a ser resolvido. | |
| opta | Objeto | verdadeiro | Um objeto de opções. | |
| opts.família | número | corda | 0 | falso | A família recordista. Deve ser 4, 6 ou 0. Por motivos de compatibilidade com versões anteriores, 'IPv4' e 'IPv6' são interpretados como 4 e 6, respectivamente. O valor 0 indica que os endereços IPv4 e IPv6 são retornados. Padrão: 0. |
| cb | função | falso | A função a ser chamada após a conclusão do método. |
Este módulo permite a resolução de nomes. Por exemplo, use-o para procurar endereços IP de nomes de host. Embora nomeado em homenagem ao Sistema de Nomes de Domínio (DNS), ele nem sempre usa o protocolo DNS para pesquisas. dns.lookup() usa os recursos do sistema operacional para realizar a resolução de nomes. Pode não ser necessário realizar nenhuma comunicação de rede. Para realizar a resolução de nomes da mesma forma que outros aplicativos no mesmo sistema, use dns.lookup().
lookup(hostname, opts)Documentos externos: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| nome do host | corda | falso | O nome do host a ser resolvido. | |
| opta | Objeto | verdadeiro | Um objeto de opções. | |
| opts.família | número | corda | 0 | falso | A família recordista. Deve ser 4, 6 ou 0. Por motivos de compatibilidade com versões anteriores, 'IPv4' e 'IPv6' são interpretados como 4 e 6, respectivamente. O valor 0 indica que os endereços IPv4 e IPv6 são retornados. Padrão: 0. |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
Este módulo permite interagir com o sistema de arquivos de uma forma modelada em funções POSIX padrão.
O Application Sandbox restringe o acesso ao sistema de arquivos. Consulte a documentação do Application Sandbox para obter mais informações: https://sockets.sh/guides/#working-with-the-file-system-on-ios
Para usar as APIs baseadas em promessas:
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;Para usar as APIs de retorno de chamada e assíncronas:
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
Verifique de forma assíncrona o acesso a um arquivo para um determinado modo, chamando callback em caso de sucesso ou erro.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| modo | corda | F_OK(0) | verdadeiro | |
| ligar de volta | função (errar, fd) | falso |
chmod(path, mode, callback)Documentos externos: https://nodejs.org/api/fs.html#fschmodpath-mode-callback
Altera de forma assíncrona as permissões de um arquivo. Nenhum argumento além de uma possível exceção é fornecido ao retorno de chamada de conclusão
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| modo | número | falso | ||
| ligar de volta | função (errar) | falso |
close(fd, callback) Fechar de forma assíncrona um descritor de arquivo chamando callback em caso de sucesso ou erro.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| fd | número | falso | ||
| ligar de volta | função (errar) | verdadeiro |
copyFile() Esta é uma FunctionDeclaration chamada copyFile em fs/index.js , é exportada, mas não está documentada.
createReadStream(path, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | fs.ReadStream |
createWriteStream(path, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | fs.WriteStream |
fstat(fd, options, callback)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback
Invoca o retorno de chamada com <fs.Stats> para o descritor de arquivo. Consulte a documentação do POSIX fstat(2) para obter mais detalhes.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| fd | número | falso | Um descritor de arquivo. | |
| opções | Objeto | verdadeiro | Um objeto de opções. | |
| ligar de volta | função | falso | A função a ser chamada após a conclusão. |
open(path, flags , mode , callback) Abra de forma assíncrona um arquivo chamando callback em caso de sucesso ou erro.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| bandeiras | corda | R | verdadeiro | |
| modo | corda | 0o666 | verdadeiro | |
| ligar de volta | função (errar, fd) | falso |
opendir(path, options, callback) Abra de forma assíncrona um diretório que chama callback em caso de sucesso ou erro.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | Objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.withFileTypes | booleano | falso | verdadeiro | |
| ligar de volta | função (errar, fd) | falso |
read(fd, buffer, offset, length, position, callback)Leitura assíncrona de um descritor de arquivo aberto.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| fd | número | falso | ||
| buffer | objeto | Tampão | TypedArray | falso | O buffer no qual os dados serão gravados. | |
| desvio | número | falso | A posição no buffer na qual gravar os dados. | |
| comprimento | número | falso | O número de bytes a serem lidos. | |
| posição | número | BigInt | nulo | falso | Especifica onde começar a leitura no arquivo. Se position for null ou -1 , os dados serão lidos da posição atual do arquivo e a posição do arquivo será atualizada. Se a posição for um número inteiro, a posição do arquivo permanecerá inalterada. | |
| ligar de volta | função(err, bytesRead, buffer) | falso |
readdir(path, options, callback)Leia de forma assíncrona todas as entradas em um diretório.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.withFileTypes | booleano | falso | verdadeiro | |
| ligar de volta | função (errar, buffer) | falso |
readFile(path, options, callback)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | número | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.flag | corda | R | verdadeiro | |
| opções.sinal | Abortar sinal | verdadeiro | ||
| ligar de volta | função (errar, buffer) | falso |
stat(path, options, callback)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | número | falso | nome do arquivo ou descritor de arquivo | |
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.flag | corda | R | verdadeiro | |
| opções.sinal | Abortar sinal | verdadeiro | ||
| ligar de volta | função (errar, dados) | falso |
writeFile(path, data, options, callback)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | número | falso | nome do arquivo ou descritor de arquivo | |
| dados | corda | Tampão | TypedArray | Visualização de dados | objeto | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.modo | corda | 0o666 | verdadeiro | |
| opções.flag | corda | c | verdadeiro | |
| opções.sinal | Abortar sinal | verdadeiro | ||
| ligar de volta | função (errar) | falso |
writev() Esta é uma FunctionDeclaration chamada writev em fs/index.js , é exportada, mas não está documentada.
access(path, mode, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode
Verifique de forma assíncrona o acesso a um arquivo.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| modo | corda | verdadeiro | ||
| opções | objeto | verdadeiro |
chmod(path, mode)Documentos externos: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| modo | número | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
mkdir(path, options)Cria um diretório de forma assíncrona.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | Corda | falso | O caminho para criar | |
| opções | Objeto | falso | O argumento de opções opcionais pode ser um inteiro especificando o modo (permissão e bits fixos) ou um objeto com uma propriedade mode e uma propriedade recursiva indicando se os diretórios pai devem ser criados. Chamar fs.mkdir() quando path é um diretório que existe resulta em erro apenas quando recursivo é falso. |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Primícia | Em caso de sucesso, cumpre com indefinido se recursivo for falso, ou o primeiro caminho de diretório criado se recursivo for verdadeiro. |
open(path, flags, mode)Documentos externos: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
Abra um arquivo de forma assíncrona.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| bandeiras | corda | falso | padrão: 'r' | |
| modo | corda | falso | padrão: 0o666 |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
opendir(path, options)Documentos externos: https://nodejs.org/api/fs.html#fspromisesopendirpath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.bufferSize | número | 32 | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<FileSystem,Dir> |
readdir(path, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | utf8 | verdadeiro | |
| opções.withFileTypes | booleano | falso | verdadeiro |
readFile(path, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | nulo | nulo | verdadeiro | |
| opções.flag | corda | R | verdadeiro | |
| opções.sinal | Abortar sinal | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<Buffer | string> |
stat(path, options)Documentos externos: https://nodejs.org/api/fs.html#fspromisesstatpath-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | falso | ||
| opções | objeto | verdadeiro | ||
| opções.bigint | booleano | falso | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
writeFile(path, data, options)Documentos externos: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| caminho | corda | Tampão | URL | identificador de arquivo | falso | nome do arquivo ou FileHandle | |
| dados | corda | Tampão | Matriz | Visualização de dados | TypedArray | Fluxo | falso | ||
| opções | objeto | verdadeiro | ||
| opções.codificação | corda | nulo | utf8 | falso | |
| opções.modo | número | 0o666 | falso | |
| opções.flag | corda | c | falso | |
| opções.sinal | Abortar sinal | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
Esta é uma VariableDeclaration chamada DEFAULT_STREAM_HIGH_WATER_MARK em fs/stream.js , é exportada, mas não está documentada.
ReadStream (estende Readable ) Um fluxo Readable para um FileHandle .
constructor() Construtor da classe ReadStream
setHandle(handle)Define o identificador de arquivo para o ReadStream.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| lidar | identificador de arquivo | falso |
highWaterMark()O tamanho máximo do buffer para o ReadStream.
path() Caminho relativo ou absoluto do FileHandle subjacente.
pending() true se o fluxo estiver em estado pendente.
emit() Lida com a configuração shouldEmitClose de options.emitClose no construtor.
WriteStream (estende Writable ) Um fluxo Writable para um FileHandle .
constructor() Construtor da classe WriteStream
setHandle(handle)Define o identificador de arquivo para WriteStream.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| lidar | identificador de arquivo | falso |
highWaterMark()O tamanho máximo do buffer para o Writetream.
path() Caminho relativo ou absoluto do FileHandle subjacente.
pending() true se o fluxo estiver em estado pendente.
emit() Lida com a configuração shouldEmitClose de options.emitClose no construtor.
Esta é uma VariableDeclaration chamada FileReadStream em fs/stream.js , é exportada, mas não está documentada.
Esta é uma VariableDeclaration chamada FileWriteStream em fs/stream.js , é exportada, mas não está documentada.
Esta é uma API de baixo nível da qual você não precisa, a menos que esteja implementando uma biblioteca sobre o Socket SDK. Um aplicativo Socket SDK possui dois ou três processos.
Render , a UI onde o HTML, CSS e JS são executados.Bridge , a fina camada de código que gerencia tudo.Main , para aplicativos que precisam executar trabalhos de computação mais pesados. E ao contrário do elétron, é opcional.O processo Bridge gerencia o processo Render e Main, podendo também intermediar dados entre eles.
O processo de vinculação usa entrada e saída padrão como forma de comunicação. Os dados gravados na extremidade de gravação do canal são armazenados em buffer pelo sistema operacional até serem lidos na extremidade de leitura do canal.
O protocolo IPC usa um esquema simples semelhante a URI. Os dados são passados como ArrayBuffers.
ipc://command?key1=value1&key2=value2...
postMessage() Esta é uma FunctionDeclaration chamada postMessage em ipc.js , é exportada, mas não está documentada.
Representa um status OK IPC.
Representa um status ERRO IPC.
Tempo limite em milissegundos para solicitações IPC.
Símbolo para a propriedade ipc.debug.enabled
parseSeq(seq, options) Analisa seq como valor inteiro
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| sequência | corda | número | falso | ||
| opções | objeto | verdadeiro | ||
| opções.bigint | booleano | falso | falso |
debug(enable) Se debug.enabled === true , a saída de depuração será impressa no console.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| habilitar | booleano | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | booleano |
Message (estende URL ) Um contêiner para uma mensagem IPC baseado em um esquema URI ipc:// .
PROTOCOL()O protocolo esperado para uma mensagem IPC.
from(input, params) Cria uma instância Message a partir de uma variedade de entradas.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| entrada | corda | URL | Mensagem | Tampão | objeto | falso | ||
| parâmetros | objeto | corda | URLSearchParams | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Mensagem |
isValidInput(input) Predicado para determinar se input é válida para construir uma nova instância Message .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| entrada | corda | URL | Mensagem | Tampão | objeto | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | booleano |
constructor(input) Construtor de classe de Message .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| entrada | corda | URL | falso |
command()Nome da mensagem IPC computado.
name()Nome da mensagem IPC computado.
id() Valor id calculado para o comando.
seq() Valor seq (sequência) calculado para o comando.
value()Valor de mensagem calculado potencialmente fornecido em parâmetros de mensagem. Este valor é decodificado automaticamente, mas não tratado como JSON.
index() Valor index calculado para o comando potencialmente referindo-se ao índice da janela no qual o comando tem escopo ou é originado. Se não for especificado nos parâmetros da mensagem, esse valor será padronizado como -1 .
json() Valor calculado analisado como JSON. Este valor será null se o valor não estiver presente ou se for JSON inválido.
params()Objeto somente leitura computado de parâmetros de mensagem.
entries()Retorna parâmetros computados como entradas
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Array<Array<string,misto>> |
set(key, value) Defina um value de parâmetro por key .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| chave | corda | falso | ||
| valor | misturado | falso |
get(key, defaultValue) Obtenha um valor de parâmetro por key .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| chave | corda | falso | ||
| valor padrão | misturado | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | misturado |
delete(key) Exclua um parâmetro por key .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| chave | corda | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | booleano |
keys()Chaves de parâmetros computadas.
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Variedade |
values()Valores de parâmetros calculados.
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Variedade |
has(key) Predicado para determinar se key do parâmetro está presente nos parâmetros.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| chave | corda | falso |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | booleano |
toJSON() Converte uma instância Message em um objeto JSON simples.
Um tipo de resultado usado internamente para lidar com valores de resultados IPC da camada nativa que estão no formato { err?, data? } . As propriedades data e err neste tipo de objeto estão em forma de tupla e podem ser acessadas em [data?,err?]
from(result, maybeError, maybeSource) Cria uma instância Result a partir da entrada que pode ser um objeto como { err?, data? } , uma instância Error ou apenas data .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| resultado | objeto | Erro | misturado | verdadeiro | ||
| talvezErro | Erro | verdadeiro | ||
| talvezFonte | corda | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Resultado |
constructor(err , data , source ) Construtor da classe de Result .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| errar | Erro | nulo | verdadeiro | |
| dados | objeto | nulo | verdadeiro | |
| fonte | corda | indefinido | verdadeiro |
length()Comprimento do resultado calculado.
ready()Aguarda que a camada IPC nativa esteja pronta e exposta no objeto de janela global.
sendSync(command, params) Envia um comando IPC síncrono por XHR, retornando um Result em caso de sucesso ou erro.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| comando | corda | falso | ||
| parâmetros | objeto | corda | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Resultado |
emit(name, value, target , options) Emitir evento a ser despachado no objeto window .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| nome | corda | falso | ||
| valor | Misturado | falso | ||
| alvo | EventTarget | janela | verdadeiro | |
| opções | Objeto | verdadeiro |
resolve(seq, value) Resolve uma solicitação por seq com valor possível.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| sequência | corda | falso | ||
| valor | Misturado | falso |
send(command, value)Envia uma solicitação de comando IPC assíncrona com parâmetros.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| comando | corda | falso | ||
| valor | Misturado | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
write(command, params, buffer, options)Envia uma solicitação de comando IPC assíncrona com parâmetros e bytes em buffer.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| comando | corda | falso | ||
| parâmetros | objeto | verdadeiro | ||
| buffer | Tampão | TipoArray | ArrayBuffer | corda | Variedade | verdadeiro | ||
| opções | objeto | verdadeiro |
request(command, params, options)Envia uma solicitação de comando IPC assíncrona com parâmetros solicitando uma resposta com bytes em buffer.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| comando | corda | falso | ||
| parâmetros | objeto | verdadeiro | ||
| opções | objeto | verdadeiro |
createBinding(domain, ctx)Fábrica para criar uma API IPC baseada em proxy.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| domínio | corda | falso | ||
| ctx | função | objeto | verdadeiro | ||
| ctx.default | corda | verdadeiro |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Procurador |
Este módulo fornece informações normalizadas do sistema de todos os principais sistemas operacionais.
arch() Esta é uma FunctionDeclaration chamada arch em os.js , é exportada, mas não documentada.
networkInterfaces() Esta é uma FunctionDeclaration chamada networkInterfaces em os.js , é exportada, mas não documentada.
platform() Esta é uma platform chamada FunctionDeclaration em os.js , é exportada, mas não documentada.
type() Este é um type chamado FunctionDeclaration em os.js , é exportado, mas não está documentado.
isWindows() Esta é uma FunctionDeclaration chamada isWindows em os.js , é exportada, mas não documentada.
tmpdir() Esta é uma FunctionDeclaration chamada tmpdir em os.js , é exportada, mas não está documentada.
Esta é uma VariableDeclaration chamada EOL em os.js , é exportada, mas não documentada.
Esta é uma ClassDeclaration chamada Path em path/path.js , é exportada, mas não está documentada.
cwd(opts)Calcula o diretório de trabalho atual para um caminho
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opta | objeto | verdadeiro | ||
opts.posix Defina como true para forçar o caminho do estilo POSIX | booleano | verdadeiro |
constructor(opts) Construtor de classe Path .
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opta | objeto | verdadeiro | ||
| opts.root | corda | verdadeiro | ||
| opts.base | corda | verdadeiro | ||
| opts.nome | corda | verdadeiro | ||
| opts.dir | corda | verdadeiro | ||
| opts.ext | corda | verdadeiro |
resolve()normalize()homedir()| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | corda | O diretório inicial do usuário atual. |
exit(code)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| código | número | 0 | verdadeiro | O código de saída. Padrão: 0. |
Fornece métodos específicos de tempo de execução
Esta é uma VariableDeclaration chamada currentWindow em runtime.js , é exportada, mas não documentada.
Esta é uma VariableDeclaration chamada debug em runtime.js , é exportada, mas não documentada.
Esta é uma VariableDeclaration chamada config em runtime.js , é exportada, mas não documentada.
send() Esta é uma FunctionDeclaration chamada send em runtime.js , é exportada, mas não documentada.
getWindows() Esta é uma FunctionDeclaration chamada getWindows em runtime.js , é exportada, mas não está documentada.
openExternal() Esta é uma FunctionDeclaration chamada openExternal em runtime.js , é exportada, mas não está documentada.
exit(options)Encerra o processo de back-end e, em seguida, encerra o processo de renderização. O código de saída usado é o código de saída final para o sistema operacional.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opções | objeto | falso | um objeto de opções |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
setTitle(options)Define o título da janela (se aplicável).
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opções | objeto | falso | um objeto de opções |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
inspect() Esta é uma FunctionDeclaration chamada inspect em runtime.js , é exportada, mas não documentada.
show(opts)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opta | objeto | falso | um objeto de opções |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
hide(opts)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opta | objeto | falso | um objeto de opções |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
navigate(opts)| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opta | objeto | falso | um objeto de opções | |
| opts.window | número | janela atual | falso | o índice da janela |
| opts.url | número | falso | o caminho para o arquivo HTML a ser carregado na janela |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa<ipc.Result> |
setWindowBackgroundColor() Esta é uma FunctionDeclaration chamada setWindowBackgroundColor em runtime.js , é exportada, mas não está documentada.
setContextMenu(options)Abre um menu de contexto nativo.
| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opções | objeto | falso | um objeto de opções |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
setSystemMenuItemEnabled() Esta é uma FunctionDeclaration chamada setSystemMenuItemEnabled em runtime.js , é exportada, mas não está documentada.
setSystemMenu(options)Defina o menu nativo do aplicativo.
O Socket Runtime fornece uma DSL minimalista que facilita a criação de sistemas nativos de plataforma cruzada e menus de contexto.
Os menus são criados em tempo de execução. Eles podem ser criados a partir do processo Principal ou de Renderização. Eles podem ser recriados instantaneamente chamando o método setSystemMenu .
O método usa uma string. Aqui está um exemplo de menu. O ponto e vírgula é significativo indica o fim do menu. Use um sublinhado quando não houver tecla aceleradora. Modificadores são opcionais. E opções de menu do sistema operacional bem conhecidas, como o menu de edição, obterão aceleradores automaticamente, você não precisa especificá-los.
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;
` ) Para criar um separador, use três travessões --- .
Os modificadores do acelerador são usados como indicadores visuais, mas não têm um impacto material, pois a ligação real da tecla é feita no ouvinte do evento.
Uma letra maiúscula implica que o acelerador é modificado pela tecla Shift .
Aceleradores adicionais são Meta , Control , Option , cada um separado por vírgulas. Se um não for aplicável a uma plataforma, será simplesmente ignorado.
No MacOS Meta é igual a Command .
Se você quiser desabilitar um item de menu, basta prefixar o item com ! personagem. Isso fará com que o item pareça desabilitado quando o menu do sistema for renderizado.
Sentimos que os menus aninhados são um antipadrão. Nós não os usamos. Se você tiver um argumento forte a favor deles e uma solicitação pull muito simples que os faça funcionar, podemos considerá-los.
Quando um item de menu é ativado, ele gera o evento menuItemSelected no código de front-end, você pode então se comunicar com seu código de back-end, se desejar, a partir daí.
Por exemplo, se o item Apple estiver selecionado no menu Other ...
window . addEventListener ( 'menuItemSelected' , event => {
assert ( event . detail . parent === 'Other' )
assert ( event . detail . title === 'Apple' )
} )| Argumento | Tipo | Padrão | Opcional | Descrição |
|---|---|---|---|---|
| opções | objeto | falso | um objeto de opções | |
| opções.valor | corda | falso | o layout do menu | |
| opções.index | número | falso | a janela a ser segmentada (se aplicável) |
| Valor de retorno | Tipo | Descrição |
|---|---|---|
| Não especificado | Promessa |
reload() Esta é uma FunctionDeclaration chamada reload em runtime.js , é exportada, mas não documentada.
