socket api
1.0.0
Une API multiplateforme de haut niveau pour Bluetooth Pub-Sub
Bluetooth (étend EventEmitter )Créez une instance d'un service Bluetooth.
constructor(serviceId) constructeur est un exemple de propriété définie sur true Crée un nouveau service avec des paires clé-valeur
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| ID de service | chaîne | FAUX | Étant donné une valeur par défaut pour déterminer le type |
start()Démarrez le service Bluetooth.
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
subscribe(id )Commencez à rechercher les valeurs publiées qui correspondent à un UUID bien connu. Une fois abonné à un UUID, les événements qui correspondent à cet UUID seront émis. Pour recevoir ces événements vous pouvez ajouter un écouteur d'événements, par exemple...
const ble = new Bluetooth ( id )
ble . subscribe ( uuid )
ble . on ( uuid , ( data , details ) => {
// ...do something interesting
} )| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| identifiant | chaîne | FAUX | Un UUID bien connu |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
publish(id, value)Commencez à annoncer une nouvelle valeur pour un UUID bien connu
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| identifiant | chaîne | FAUX | Un UUID bien connu | |
| valeur | chaîne | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
Documents externes : https://nodejs.org/api/buffer.html#buffer_class_buffer
Le module buffer de node.js, pour le navigateur.
Si Buffer.TYPED_ARRAY_SUPPORT : === true Utiliser l'implémentation Uint8Array (la plus rapide) === false Afficher l'avertissement et recommander d'utiliser buffer v4.x qui a une implémentation Object (la plus compatible, même IE6)
Les navigateurs prenant en charge les tableaux typés sont IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Nous signalons que le navigateur ne prend pas en charge les tableaux typés s'ils ne peuvent pas être sous-classés à l'aide de proto . Firefox 4-29 ne prend pas en charge l'ajout de nouvelles propriétés à Uint8Array (Voir : https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 ne prend pas en charge le proto et possède une implémentation de tableau typé boguée.
Si Buffer.TYPED_ARRAY_SUPPORT : === true Utiliser l'implémentation Uint8Array (la plus rapide) === false Afficher l'avertissement et recommander d'utiliser buffer v4.x qui a une implémentation Object (la plus compatible, même IE6)
Les navigateurs prenant en charge les tableaux typés sont IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Nous signalons que le navigateur ne prend pas en charge les tableaux typés s'ils ne peuvent pas être sous-classés à l'aide de proto . Firefox 4-29 ne prend pas en charge l'ajout de nouvelles propriétés à Uint8Array (Voir : https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 ne prend pas en charge le proto et possède une implémentation de tableau typé boguée.
Si Buffer.TYPED_ARRAY_SUPPORT : === true Utiliser l'implémentation Uint8Array (la plus rapide) === false Afficher l'avertissement et recommander d'utiliser buffer v4.x qui a une implémentation Object (la plus compatible, même IE6)
Les navigateurs prenant en charge les tableaux typés sont IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Nous signalons que le navigateur ne prend pas en charge les tableaux typés s'ils ne peuvent pas être sous-classés à l'aide de proto . Firefox 4-29 ne prend pas en charge l'ajout de nouvelles propriétés à Uint8Array (Voir : https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 ne prend pas en charge le proto et possède une implémentation de tableau typé boguée.
Si Buffer.TYPED_ARRAY_SUPPORT : === true Utiliser l'implémentation Uint8Array (la plus rapide) === false Afficher l'avertissement et recommander d'utiliser buffer v4.x qui a une implémentation Object (la plus compatible, même IE6)
Les navigateurs prenant en charge les tableaux typés sont IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Nous signalons que le navigateur ne prend pas en charge les tableaux typés s'ils ne peuvent pas être sous-classés à l'aide de proto . Firefox 4-29 ne prend pas en charge l'ajout de nouvelles propriétés à Uint8Array (Voir : https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 ne prend pas en charge le proto et possède une implémentation de tableau typé boguée.
Le constructeur Buffer renvoie les instances de Uint8Array dont le prototype a été modifié en Buffer.prototype . De plus, Buffer est une sous-classe de Uint8Array , donc les instances renvoyées auront toutes les méthodes Buffer du nœud et les méthodes Uint8Array . La notation entre crochets fonctionne comme prévu : elle renvoie un seul octet.
Le prototype Uint8Array reste inchangé.
Fonctionnellement équivalent à Buffer(arg, encoding) mais renvoie une TypeError si la valeur est un nombre. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
Fonctionnellement équivalent à Buffer(arg, encoding) mais renvoie une TypeError si la valeur est un nombre. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
Fonctionnellement équivalent à Buffer(arg, encoding) mais renvoie une TypeError si la valeur est un nombre. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
Fonctionnellement équivalent à Buffer(arg, encoding) mais renvoie une TypeError si la valeur est un nombre. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
Crée une nouvelle instance de Buffer remplie. alloc(taille[, remplissage[, encodage]])
Crée une nouvelle instance de Buffer remplie. alloc(taille[, remplissage[, encodage]])
Crée une nouvelle instance de Buffer remplie. alloc(taille[, remplissage[, encodage]])
Crée une nouvelle instance de Buffer remplie. alloc(taille[, remplissage[, encodage]])
Équivalent à Buffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à Buffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à Buffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à Buffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à SlowBuffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à SlowBuffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à SlowBuffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Équivalent à SlowBuffer(num), crée par défaut une instance de Buffer non remplie de zéros.
Quelques méthodes de haut niveau autour de l'API crypto.subtle pour obtenir des octets aléatoires et un hachage.
API WebCrypto
getRandomValues(buffer)Documents externes : https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
Générer des valeurs aléatoires cryptographiquement fortes dans buffer
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| tampon | Tableau typé | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Tableau typé |
Taille totale maximale des octets aléatoires par page
Taille totale maximale pour les octets aléatoires.
Montant total maximum alloué par page d'octets (max/quota)
randomBytes(size) Génère des octets aléatoires size .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| taille | nombre | FAUX | Le nombre d'octets à générer. La taille ne doit pas être supérieure à 2**31 - 1. |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Tampon | Une promesse qui se résout avec une instance de socket.Buffer avec des octets aléatoires. |
createDigest(algorithm, message)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| algorithme | chaîne | FAUX | SHA-1 | |
| message | Tampon | Tableau typé | Vue de données | FAUX | Une instance de socket.Buffer, TypedArray ou Dataview. |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse | Une promesse qui se résout avec une instance de socket.Buffer avec le hachage. |
Ce module fournit une implémentation de sockets de datagramme UDP. Il ne fournit (encore) aucune des méthodes ou propriétés de multidiffusion.
ERR_SOCKET_ALREADY_BOUND (étend SocketError )Lancé lorsqu'un socket est déjà lié.
ERR_SOCKET_DGRAM_IS_CONNECTED (étend SocketError )Lancé lorsque la prise est déjà connectée.
ERR_SOCKET_DGRAM_NOT_CONNECTED (étend SocketError )Lancé lorsque la prise n'est pas connectée.
ERR_SOCKET_DGRAM_NOT_RUNNING (étend SocketError )Lancé lorsque le socket n'est pas en cours d'exécution (non lié ou connecté).
ERR_SOCKET_BAD_TYPE (étend TypeError )Levé lorsqu'un mauvais type de socket est utilisé dans un argument.
ERR_SOCKET_BAD_PORT (étend RangeError )Lancé lorsqu'un mauvais port est donné.
createSocket(options, callback) Crée une instance Socket . si ()
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| choix | chaîne | Objet | FAUX | soit une chaîne (« udp4 » ou « udp6 »), soit un objet d'options | |
| options.type | chaîne | vrai | La famille des sockets. Doit être « udp4 » ou « udp6 ». Requis. | |
| options.reuseAddr | booléen | FAUX | vrai | Lorsque vrai, socket.bind() réutilisera l'adresse, même si un autre processus y a déjà lié un socket. Par défaut : faux. |
| options.ipv6 uniquement | booléen | FAUX | vrai | Définir ipv6Only sur true désactivera la prise en charge de la double pile, c'est-à-dire que la liaison à l'adresse :: ne rendra pas 0.0.0.0 lié. Par défaut : faux. |
| options.recvBufferSize | nombre | vrai | Définit la valeur du socket SO_RCVBUF. | |
| options.sendBufferSize | nombre | vrai | Définit la valeur du socket SO_SNDBUF. | |
| options.signal | Signal d'abandon | vrai | Un AbortSignal qui peut être utilisé pour fermer un socket. | |
| rappel | fonction | vrai | Attaché en tant qu'écouteur pour les événements « message ». Facultatif. |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Douille |
Socket (étend EventEmitter )De nouvelles instances de dgram.Socket sont créées à l'aide de dgram.createSocket(). Le nouveau mot-clé ne doit pas être utilisé pour créer des instances dgram.Socket.
bind(port, address, callback)Documents externes : https://nodejs.org/api/dgram.html#socketbindport-address-callback
Écouter les messages de datagramme sur un port nommé et une adresse facultative. Si l'adresse n'est pas spécifiée, le système d'exploitation tentera d'écouter toutes les adresses. Une fois la liaison terminée, un événement « d'écoute » est émis et la fonction de rappel facultative est appelée.
Si la liaison échoue, un événement « erreur » est émis.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| port | nombre | FAUX | Le port sur lequel écouter les messages | |
| adresse | chaîne | FAUX | L'adresse à laquelle se lier (0.0.0.0) | |
| rappel | fonction | FAUX | Sans paramètres. Appelé lorsque la liaison est terminée. |
connect(port, host, connectListener)Documents externes : https://nodejs.org/api/dgram.html#socketconnectport-address-callback
Associe le dgram.Socket à une adresse et un port distants. Chaque message envoyé par ce handle est automatiquement envoyé à cette destination. De plus, le socket ne recevra que les messages de cet homologue distant. Essayer d'appeler connect() sur un socket déjà connecté entraînera une exception ERR_SOCKET_DGRAM_IS_CONNECTED. Si l'adresse n'est pas fournie, '127.0.0.1' (pour les sockets udp4) ou '::1' (pour les sockets udp6) sera utilisé par défaut. Une fois la connexion terminée, un événement « connect » est émis et la fonction de rappel facultative est appelée. En cas d'échec, le rappel est appelé ou, à défaut, un événement 'erreur' est émis.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| port | nombre | FAUX | Port auquel le client doit se connecter. | |
| hôte | chaîne | vrai | Hôte auquel le client doit se connecter. | |
| connecterListener | fonction | vrai | Paramètre commun des méthodes socket.connect(). Sera ajouté une fois en tant qu'écouteur pour l'événement « connect ». |
disconnect()Documents externes : https://nodejs.org/api/dgram.html#socketdisconnect
Une fonction synchrone qui dissocie un dgram.Socket connecté de son adresse distante. Essayer d'appelerconnect() sur un socket non lié ou déjà déconnecté entraînera une exception ERR_SOCKET_DGRAM_NOT_CONNECTED.
send(msg, offset, length, port, address, callback)Documents externes : https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback
Diffuse un datagramme sur le socket. Pour les sockets sans connexion, le port de destination et l'adresse doivent être spécifiés. Les sockets connectés, en revanche, utiliseront leur point de terminaison distant associé, les arguments de port et d'adresse ne doivent donc pas être définis.
L'argument msg contient le message à envoyer. Selon son type, un comportement différent peut s'appliquer. Si msg est un Buffer, n'importe quel TypedArray ou un DataView, le décalage et la longueur spécifient respectivement le décalage dans le tampon où commence le message et le nombre d'octets dans le message. Si msg est une chaîne, il est automatiquement converti en tampon avec un encodage « utf8 ». Avec les messages contenant des caractères multi-octets, le décalage et la longueur seront calculés en fonction de la longueur en octets et non de la position du caractère. Si msg est un tableau, le décalage et la longueur ne doivent pas être spécifiés.
L'argument d'adresse est une chaîne. Si la valeur de l'adresse est un nom d'hôte, DNS sera utilisé pour résoudre l'adresse de l'hôte. Si l'adresse n'est pas fournie ou est nulle, '127.0.0.1' (pour les sockets udp4) ou '::1' (pour les sockets udp6) sera utilisé par défaut.
Si le socket n'a pas été précédemment lié avec un appel à lier, le socket se voit attribuer un numéro de port aléatoire et est lié à l'adresse "toutes les interfaces" ('0.0.0.0' pour les sockets udp4, '::0' pour les sockets udp6 .)
Une fonction de rappel facultative peut être spécifiée comme moyen de signaler les erreurs DNS ou de déterminer quand il est sûr de réutiliser l'objet buf. Les recherches DNS retardent le délai d'envoi d'au moins un tick de la boucle d'événements Node.js.
La seule façon de savoir avec certitude que le datagramme a été envoyé est d'utiliser un rappel. Si une erreur se produit et qu'un rappel est effectué, l'erreur sera transmise comme premier argument du rappel. Si aucun rappel n'est fourni, l'erreur est émise en tant qu'événement « erreur » sur l'objet socket.
Le décalage et la longueur sont facultatifs, mais les deux doivent être définis si l'un ou l'autre est utilisé. Ils sont pris en charge uniquement lorsque le premier argument est un Buffer, un TypedArray ou un DataView.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| message | Tampon | Tableau typé | Vue de données | chaîne | Tableau | FAUX | Message à envoyer. | |
| compenser | entier | vrai | Décalage dans le tampon où commence le message. | |
| longueur | entier | vrai | Nombre d'octets dans le message. | |
| port | entier | vrai | Port de destination. | |
| adresse | chaîne | vrai | Nom d'hôte de destination ou adresse IP. | |
| rappel | Fonction | vrai | Appelé lorsque le message a été envoyé. |
close(callback)Documents externes : https://nodejs.org/api/dgram.html#socketclosecallback
Fermez le socket sous-jacent et arrêtez d’écouter les données qu’il contient. Si un rappel est fourni, il est ajouté en tant qu'écouteur pour l'événement « close ».
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| rappel | fonction | vrai | Appelé lorsque la connexion est terminée ou en cas d'erreur. |
address()Documents externes : https://nodejs.org/api/dgram.html#socketaddress
Renvoie un objet contenant les informations d'adresse d'un socket. Pour les sockets UDP, cet objet contiendra les propriétés d'adresse, de famille et de port.
Cette méthode lance EBADF si elle est appelée sur un socket non lié.
| Valeur de retour | Taper | Description |
|---|---|---|
| socketInfo | Objet | Informations sur la prise locale |
| socketInfo.adresse | chaîne | L'adresse IP du socket |
| socketInfo.port | chaîne | Le port de la prise |
| socketInfo.famille | chaîne | La famille IP du socket |
remoteAddress()Documents externes : https://nodejs.org/api/dgram.html#sockeremoteaddress
Renvoie un objet contenant l'adresse, la famille et le port du point de terminaison distant. Cette méthode lève une exception ERR_SOCKET_DGRAM_NOT_CONNECTED si le socket n'est pas connecté.
| Valeur de retour | Taper | Description |
|---|---|---|
| socketInfo | Objet | Informations sur la prise déportée |
| socketInfo.adresse | chaîne | L'adresse IP du socket |
| socketInfo.port | chaîne | Le port de la prise |
| socketInfo.famille | chaîne | La famille IP du socket |
setRecvBufferSize(size)Documents externes : https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize
Définit l'option de socket SO_RCVBUF. Définit le tampon de réception maximum du socket en octets.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| taille | nombre | FAUX | La taille du nouveau tampon de réception |
setSendBufferSize(size)Documents externes : https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize
Définit l'option de socket SO_SNDBUF. Définit le tampon d'envoi de socket maximum en octets.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| taille | nombre | FAUX | La taille du nouveau tampon d'envoi |
getRecvBufferSize()Documents externes : https://nodejs.org/api/dgram.html#socketgetrecvbuffersize
getSendBufferSize()Documents externes : https://nodejs.org/api/dgram.html#socketgetsendbuffersize
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | nombre | la socket SO_SNDBUF envoie la taille du tampon en octets. |
Ce module permet la résolution de noms. Par exemple, utilisez-le pour rechercher les adresses IP des noms d'hôtes. Bien que son nom fasse référence au système de noms de domaine (DNS), il n'utilise pas toujours le protocole DNS pour les recherches. dns.lookup() utilise les fonctionnalités du système d'exploitation pour effectuer la résolution de noms. Il n’est peut-être pas nécessaire d’effectuer une communication réseau. Pour effectuer la résolution de noms comme le font d’autres applications sur le même système, utilisez dns.lookup().
lookup(hostname, opts, cb)Documents externes : https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
Résout un nom d'hôte (par exemple example.org ) dans le premier enregistrement A (IPv4) ou AAAA (IPv6) trouvé. Toutes les propriétés des options sont facultatives. Si options est un nombre entier, alors il doit être 4 ou 6 – si options est 0 ou non fourni, alors les adresses IPv4 et IPv6 sont toutes deux renvoyées si elles sont trouvées.
Depuis le site Web node.js...
Avec l'option all définie sur true, les arguments du rappel deviennent (err, adresses), les adresses étant un tableau d'objets avec les propriétés adresse et famille.
En cas d'erreur, err est un objet Error, où err.code est le code d'erreur. Gardez à l'esprit que err.code sera défini sur « ENOTFOUND » non seulement lorsque le nom d'hôte n'existe pas, mais également lorsque la recherche échoue d'une autre manière, par exemple en cas d'absence de descripteurs de fichiers disponibles. dns.lookup() n'a pas nécessairement quelque chose à voir avec le protocole DNS. L'implémentation utilise une fonctionnalité du système d'exploitation qui peut associer des noms à des adresses et vice versa. Cette implémentation peut avoir des conséquences subtiles mais importantes sur le comportement de n'importe quel programme Node.js. Veuillez prendre le temps de consulter la section Considérations sur la mise en œuvre avant d'utiliser dns.lookup().
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| nom d'hôte | chaîne | FAUX | Le nom d'hôte à résoudre. | |
| opte | Objet | vrai | Un objet d'options. | |
| opts.famille | numéro | chaîne | 0 | FAUX | La famille des disques. Doit être 4, 6 ou 0. Pour des raisons de compatibilité ascendante, « IPv4 » et « IPv6 » sont interprétés comme 4 et 6 respectivement. La valeur 0 indique que les adresses IPv4 et IPv6 sont toutes deux renvoyées. Par défaut : 0. |
| CB | fonction | FAUX | Fonction à appeler une fois la méthode terminée. |
Ce module permet la résolution de noms. Par exemple, utilisez-le pour rechercher les adresses IP des noms d'hôtes. Bien que son nom fasse référence au système de noms de domaine (DNS), il n'utilise pas toujours le protocole DNS pour les recherches. dns.lookup() utilise les fonctionnalités du système d'exploitation pour effectuer la résolution de noms. Il n’est peut-être pas nécessaire d’effectuer une communication réseau. Pour effectuer la résolution de noms comme le font d’autres applications sur le même système, utilisez dns.lookup().
lookup(hostname, opts)Documents externes : https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| nom d'hôte | chaîne | FAUX | Le nom d'hôte à résoudre. | |
| opte | Objet | vrai | Un objet d'options. | |
| opts.famille | numéro | chaîne | 0 | FAUX | La famille des disques. Doit être 4, 6 ou 0. Pour des raisons de compatibilité ascendante, « IPv4 » et « IPv6 » sont interprétés comme 4 et 6 respectivement. La valeur 0 indique que les adresses IPv4 et IPv6 sont toutes deux renvoyées. Par défaut : 0. |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
Ce module permet d'interagir avec le système de fichiers d'une manière calquée sur les fonctions POSIX standards.
L'Application Sandbox restreint l'accès au système de fichiers. Veuillez consulter la documentation Application Sandbox pour plus d'informations : https://sockets.sh/guides/#working-with-the-file-system-on-ios
Pour utiliser les API basées sur des promesses :
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;Pour utiliser les API de rappel et asynchrone :
import * as fs from '@socketsupply/socket-api/fs/index.js' ; access(path, mode , callback)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback
Vérifiez de manière asynchrone l'accès à un fichier pour un mode donné en appelant callback en cas de succès ou d'erreur.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| mode | chaîne | F_OK(0) | vrai | |
| rappel | fonction (erreur, fd) | FAUX |
chmod(path, mode, callback)Documents externes : https://nodejs.org/api/fs.html#fschmodpath-mode-callback
Modifie de manière asynchrone les autorisations d'un fichier. Aucun argument autre qu'une éventuelle exception n'est donné au rappel d'achèvement
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| mode | nombre | FAUX | ||
| rappel | fonction (erreur) | FAUX |
close(fd, callback) Fermez de manière asynchrone un descripteur de fichier appelant callback en cas de succès ou d'erreur.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| fd | nombre | FAUX | ||
| rappel | fonction (erreur) | vrai |
copyFile() Il s'agit d'une FunctionDeclaration nommée copyFile dans fs/index.js , elle est exportée mais non documentée.
createReadStream(path, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | fs.ReadStream |
createWriteStream(path, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | fs.WriteStream |
fstat(fd, options, callback)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback
Appelle le rappel avec le <fs.Stats> pour le descripteur de fichier. Consultez la documentation POSIX fstat(2) pour plus de détails.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| fd | nombre | FAUX | Un descripteur de fichier. | |
| choix | Objet | vrai | Un objet d'options. | |
| rappel | fonction | FAUX | La fonction à appeler une fois terminée. |
open(path, flags , mode , callback) Ouvrez de manière asynchrone un fichier appelant callback en cas de succès ou d'erreur.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| drapeaux | chaîne | r | vrai | |
| mode | chaîne | 0o666 | vrai | |
| rappel | fonction (erreur, fd) | FAUX |
opendir(path, options, callback) Ouvrez de manière asynchrone un répertoire appelant callback en cas de succès ou d'erreur.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | Objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.withFileTypes | booléen | FAUX | vrai | |
| rappel | fonction (erreur, fd) | FAUX |
read(fd, buffer, offset, length, position, callback)Lecture asynchrone à partir d'un descripteur de fichier ouvert.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| fd | nombre | FAUX | ||
| tampon | objet | Tampon | Tableau typé | FAUX | Le tampon dans lequel les données seront écrites. | |
| compenser | nombre | FAUX | La position dans le tampon dans laquelle écrire les données. | |
| longueur | nombre | FAUX | Le nombre d'octets à lire. | |
| position | numéro | BigInt | nul | FAUX | Spécifie où commencer la lecture dans le fichier. Si position est null ou -1 , les données seront lues à partir de la position actuelle du fichier et la position du fichier sera mise à jour. Si position est un nombre entier, la position du fichier sera inchangée. | |
| rappel | fonction (erreur, bytesRead, buffer) | FAUX |
readdir(path, options, callback)Lire de manière asynchrone toutes les entrées d'un répertoire.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.withFileTypes | booléen | FAUX | vrai | |
| rappel | fonction (erreur, tampon) | FAUX |
readFile(path, options, callback)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | nombre | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.flag | chaîne | r | vrai | |
| options.signal | Signal d'abandon | vrai | ||
| rappel | fonction (erreur, tampon) | FAUX |
stat(path, options, callback)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | nombre | FAUX | nom de fichier ou descripteur de fichier | |
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.flag | chaîne | r | vrai | |
| options.signal | Signal d'abandon | vrai | ||
| rappel | fonction (erreur, données) | FAUX |
writeFile(path, data, options, callback)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | nombre | FAUX | nom de fichier ou descripteur de fichier | |
| données | chaîne | Tampon | Tableau typé | Vue de données | objet | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.mode | chaîne | 0o666 | vrai | |
| options.flag | chaîne | w | vrai | |
| options.signal | Signal d'abandon | vrai | ||
| rappel | fonction (erreur) | FAUX |
writev() Il s'agit d'une FunctionDeclaration nommée writev dans fs/index.js , elle est exportée mais non documentée.
access(path, mode, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode
Vérifiez de manière asynchrone l’accès à un fichier.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| mode | chaîne | vrai | ||
| choix | objet | vrai |
chmod(path, mode)Documents externes : https://nodejs.org/api/fs.html#fspromiseschmodpath-mode
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| mode | nombre | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
mkdir(path, options)Crée de manière asynchrone un répertoire.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | Chaîne | FAUX | Le chemin pour créer | |
| choix | Objet | FAUX | L'argument optionnel des options peut être un entier spécifiant le mode (autorisation et sticky bits), ou un objet avec une propriété mode et une propriété récursive indiquant si les répertoires parents doivent être créés. L'appel de fs.mkdir() lorsque path est un répertoire qui existe entraîne une erreur uniquement lorsque récursif est faux. |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Prime | En cas de succès, remplit undéfini si récursif est faux, ou le premier chemin de répertoire créé si récursif est vrai. |
open(path, flags, mode)Documents externes : https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
Ouvrez un fichier de manière asynchrone.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| drapeaux | chaîne | FAUX | par défaut : 'r' | |
| mode | chaîne | FAUX | par défaut : 0o666 |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
opendir(path, options)Documents externes : https://nodejs.org/api/fs.html#fspromisesopendirpath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.bufferSize | nombre | 32 | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<FileSystem,Dir> |
readdir(path, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | utf8 | vrai | |
| options.withFileTypes | booléen | FAUX | vrai |
readFile(path, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | nul | nul | vrai | |
| options.flag | chaîne | r | vrai | |
| options.signal | Signal d'abandon | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<Buffer | chaîne> |
stat(path, options)Documents externes : https://nodejs.org/api/fs.html#fspromisesstatpath-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | FAUX | ||
| choix | objet | vrai | ||
| options.bigint | booléen | FAUX | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
writeFile(path, data, options)Documents externes : https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| chemin | chaîne | Tampon | URL | Descripteur de fichier | FAUX | nom de fichier ou FileHandle | |
| données | chaîne | Tampon | Tableau | Vue de données | Tableau typé | Flux | FAUX | ||
| choix | objet | vrai | ||
| options.encodage | chaîne | nul | utf8 | FAUX | |
| options.mode | nombre | 0o666 | FAUX | |
| options.flag | chaîne | w | FAUX | |
| options.signal | Signal d'abandon | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
Il s'agit d'une VariableDeclaration nommée DEFAULT_STREAM_HIGH_WATER_MARK dans fs/stream.js , elle est exportée mais non documentée.
ReadStream (étend Readable ) Un flux Readable pour un FileHandle .
constructor() Constructeur de classe ReadStream
setHandle(handle)Définit le handle de fichier pour ReadStream.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| poignée | Descripteur de fichier | FAUX |
highWaterMark()Taille maximale du tampon pour ReadStream.
path() Chemin relatif ou absolu du FileHandle sous-jacent.
pending() true si le flux est dans un état en attente.
emit() Gère le paramètre shouldEmitClose de options.emitClose dans le constructeur.
WriteStream (étend Writable ) Un flux Writable pour un FileHandle .
constructor() Constructeur de classe WriteStream
setHandle(handle)Définit le handle de fichier pour WriteStream.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| poignée | Descripteur de fichier | FAUX |
highWaterMark()La taille maximale du tampon pour le Writetream.
path() Chemin relatif ou absolu du FileHandle sous-jacent.
pending() true si le flux est dans un état en attente.
emit() Gère le paramètre shouldEmitClose de options.emitClose dans le constructeur.
Il s'agit d'une VariableDeclaration nommée FileReadStream dans fs/stream.js , elle est exportée mais non documentée.
Il s'agit d'une VariableDeclaration nommée FileWriteStream dans fs/stream.js , elle est exportée mais non documentée.
Il s'agit d'une API de bas niveau dont vous n'avez pas besoin, sauf si vous implémentez une bibliothèque au-dessus du Socket SDK. Une application Socket SDK comporte deux ou trois processus.
Render , l'interface utilisateur où le HTML, le CSS et le JS sont exécutés.Bridge , la fine couche de code qui gère tout.Main , pour les applications qui doivent exécuter des tâches de calcul plus lourdes. Et contrairement à l'électron, c'est facultatif.Le processus Bridge gère les processus Render et Main, il peut également échanger des données entre eux.
Le processus de liaison utilise une entrée et une sortie standard comme moyen de communication. Les données écrites du côté écriture du canal sont mises en mémoire tampon par le système d'exploitation jusqu'à ce qu'elles soient lues à partir du côté lecture du canal.
Le protocole IPC utilise un schéma simple de type URI. Les données sont transmises sous forme de ArrayBuffers.
ipc://command?key1=value1&key2=value2...
postMessage() Il s'agit d'une FunctionDeclaration nommée postMessage dans ipc.js , elle est exportée mais non documentée.
Représente un état OK IPC.
Représente un état ERREUR IPC.
Délai d'expiration en millisecondes pour les requêtes IPC.
Symbole de la propriété ipc.debug.enabled
parseSeq(seq, options) Analyse seq séquence sous forme de valeur entière
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| séquence | chaîne | nombre | FAUX | ||
| choix | objet | vrai | ||
| options.bigint | booléen | FAUX | FAUX |
debug(enable) Si debug.enabled === true , alors la sortie de débogage sera imprimée sur la console.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| activer | booléen | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | booléen |
Message (étend URL ) Un conteneur pour un message IPC basé sur un schéma d'URI ipc:// .
PROTOCOL()Le protocole attendu pour un message IPC.
from(input, params) Crée une instance Message à partir d'une variété d'entrées.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| saisir | chaîne | URL | Messages | Tampon | objet | FAUX | ||
| paramètres | objet | chaîne | URLSearchParams | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Message |
isValidInput(input) Prédicat pour déterminer si input est valide pour construire une nouvelle instance Message .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| saisir | chaîne | URL | Messages | Tampon | objet | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | booléen |
constructor(input) Constructeur de classe de Message .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| saisir | chaîne | URL | FAUX |
command()Nom du message IPC calculé.
name()Nom du message IPC calculé.
id() Valeur id calculée pour la commande.
seq() Valeur seq (séquence) calculée pour la commande.
value()Valeur du message calculée potentiellement donnée dans les paramètres du message. Cette valeur est automatiquement décodée, mais n'est pas traitée comme JSON.
index() Valeur index calculée pour la commande faisant potentiellement référence à l'index de fenêtre auquel la commande est étendue ou dont elle provient. Si elle n'est pas spécifiée dans les paramètres du message, cette valeur par défaut est -1 .
json() Valeur calculée analysée en JSON. Cette valeur est null si la valeur n'est pas présente ou si elle est JSON invalide.
params()Objet calculé en lecture seule des paramètres du message.
entries()Renvoie les paramètres calculés sous forme d'entrées
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Tableau<Array<string,mixed>> |
set(key, value) Définissez une value de paramètre par key .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| clé | chaîne | FAUX | ||
| valeur | mixte | FAUX |
get(key, defaultValue) Obtenez une valeur de paramètre par key .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| clé | chaîne | FAUX | ||
| valeur par défaut | mixte | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | mixte |
delete(key) Supprimer un paramètre par key .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| clé | chaîne | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | booléen |
keys()Clés de paramètres calculées.
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Tableau |
values()Valeurs de paramètres calculées.
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Tableau |
has(key) Prédicat pour déterminer si key de paramètre est présente dans les paramètres.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| clé | chaîne | FAUX |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | booléen |
toJSON() Convertit une instance Message en un objet JSON simple.
Un type de résultat utilisé en interne pour gérer les valeurs de résultat IPC de la couche native qui se présentent sous la forme de { err?, data? } . Les propriétés data et err sur ce type d'objet sont sous forme de tuple et sont accessibles à l'adresse [data?,err?]
from(result, maybeError, maybeSource) Crée une instance Result à partir d'une entrée qui peut être un objet tel que { err?, data? } , une instance Error ou simplement data .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| résultat | objet | Erreur | mixte | vrai | ||
| peut-êtreErreur | Erreur | vrai | ||
| peut-êtreSource | chaîne | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Résultat |
constructor(err , data , source ) Constructeur de classe Result .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| se tromper | Erreur | nul | vrai | |
| données | objet | nul | vrai | |
| source | chaîne | indéfini | vrai |
length()Longueur du résultat calculé.
ready()Attend que la couche IPC native soit prête et exposée sur l'objet fenêtre global.
sendSync(command, params) Envoie une commande IPC synchrone sur XHR renvoyant un Result en cas de succès ou d'erreur.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| commande | chaîne | FAUX | ||
| paramètres | objet | chaîne | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Résultat |
emit(name, value, target , options) Émettre un événement à distribuer sur l'objet window .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| nom | chaîne | FAUX | ||
| valeur | Mixte | FAUX | ||
| cible | Cible d'événement | fenêtre | vrai | |
| choix | Objet | vrai |
resolve(seq, value) Résout une requête par seq avec une valeur possible.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| séquence | chaîne | FAUX | ||
| valeur | Mixte | FAUX |
send(command, value)Envoie une demande de commande IPC asynchrone avec des paramètres.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| commande | chaîne | FAUX | ||
| valeur | Mixte | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
write(command, params, buffer, options)Envoie une demande de commande IPC asynchrone avec des paramètres et des octets mis en mémoire tampon.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| commande | chaîne | FAUX | ||
| paramètres | objet | vrai | ||
| tampon | Tampon | TypeArray | TableauBuffer | chaîne | Tableau | vrai | ||
| choix | objet | vrai |
request(command, params, options)Envoie une demande de commande IPC asynchrone avec des paramètres demandant une réponse avec des octets mis en mémoire tampon.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| commande | chaîne | FAUX | ||
| paramètres | objet | vrai | ||
| choix | objet | vrai |
createBinding(domain, ctx)Factory pour créer une API IPC basée sur un proxy.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| domaine | chaîne | FAUX | ||
| cx | fonction | objet | vrai | ||
| ctx.par défaut | chaîne | vrai |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Procuration |
Ce module fournit des informations système normalisées de tous les principaux systèmes d'exploitation.
arch() Il s'agit d'une FunctionDeclaration nommée arch dans os.js , elle est exportée mais non documentée.
networkInterfaces() Il s'agit d'une FunctionDeclaration nommée networkInterfaces dans os.js , elle est exportée mais non documentée.
platform() Il s'agit d'une FunctionDeclaration nommée platform dans os.js , elle est exportée mais non documentée.
type() Il s'agit d'une FunctionDeclaration nommée type dans os.js , elle est exportée mais non documentée.
isWindows() Il s'agit d'une FunctionDeclaration nommée isWindows dans os.js , elle est exportée mais non documentée.
tmpdir() Il s'agit d'une FunctionDeclaration nommée tmpdir dans os.js , elle est exportée mais non documentée.
Il s'agit d'une VariableDeclaration nommée EOL dans os.js , elle est exportée mais non documentée.
Il s'agit d'une ClassDeclaration nommée Path dans path/path.js , elle est exportée mais non documentée.
cwd(opts)Calcule le répertoire de travail actuel pour un chemin
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| opte | objet | vrai | ||
opts.posix Définir sur true pour forcer le chemin de style POSIX | booléen | vrai |
constructor(opts) Constructeur de classe Path .
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| opte | objet | vrai | ||
| opts.root | chaîne | vrai | ||
| opts.base | chaîne | vrai | ||
| opts.nom | chaîne | vrai | ||
| opts.dir | chaîne | vrai | ||
| opts.ext | chaîne | vrai |
resolve()normalize()homedir()| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | chaîne | Le répertoire personnel de l'utilisateur actuel. |
exit(code)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| code | nombre | 0 | vrai | Le code de sortie. Par défaut : 0. |
Fournit des méthodes spécifiques à l'exécution
Il s'agit d'une VariableDeclaration nommée currentWindow dans runtime.js , elle est exportée mais non documentée.
Il s'agit d'une VariableDeclaration nommée debug dans runtime.js , elle est exportée mais non documentée.
Il s'agit d'une VariableDeclaration nommée config dans runtime.js , elle est exportée mais non documentée.
send() Il s'agit d'une FunctionDeclaration nommée send dans runtime.js , elle est exportée mais non documentée.
getWindows() Il s'agit d'une FunctionDeclaration nommée getWindows dans runtime.js , elle est exportée mais non documentée.
openExternal() Il s'agit d'une FunctionDeclaration nommée openExternal dans runtime.js , elle est exportée mais non documentée.
exit(options)Quitte le processus backend puis quitte le processus de rendu, le code de sortie utilisé est le code de sortie final vers le système d'exploitation.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| choix | objet | FAUX | un objet d'options |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
setTitle(options)Définit le titre de la fenêtre (le cas échéant).
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| choix | objet | FAUX | un objet d'options |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
inspect() Il s'agit d'une FunctionDeclaration nommée inspect dans runtime.js , elle est exportée mais non documentée.
show(opts)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| opte | objet | FAUX | un objet d'options |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
hide(opts)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| opte | objet | FAUX | un objet d'options |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
navigate(opts)| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| opte | objet | FAUX | un objet d'options | |
| opts.fenêtre | nombre | fenêtre actuelle | FAUX | l'index de la fenêtre |
| opts.url | nombre | FAUX | le chemin d'accès au fichier HTML à charger dans la fenêtre |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse<ipc.Result> |
setWindowBackgroundColor() Il s'agit d'une FunctionDeclaration nommée setWindowBackgroundColor dans runtime.js , elle est exportée mais non documentée.
setContextMenu(options)Ouvre un menu contextuel natif.
| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| choix | objet | FAUX | un objet d'options |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
setSystemMenuItemEnabled() Il s'agit d'une FunctionDeclaration nommée setSystemMenuItemEnabled dans runtime.js , elle est exportée mais non documentée.
setSystemMenu(options)Définissez le menu natif de l'application.
Socket Runtime fournit un DSL minimaliste qui facilite la création de menus contextuels et de systèmes natifs multiplateformes.
Les menus sont créés au moment de l'exécution. Ils peuvent être créés à partir du processus Main ou Render. Ils peuvent être recréés instantanément en appelant la méthode setSystemMenu .
La méthode prend une chaîne. Voici un exemple de menu. Le point virgule significatif indique la fin du menu. Utilisez un trait de soulignement lorsqu'il n'y a pas de touche accélératrice. Les modificateurs sont facultatifs. Et les options bien connues du menu du système d'exploitation, comme le menu d'édition, obtiendront automatiquement des accélérateurs que vous n'avez pas besoin de spécifier.
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;
` ) Pour créer un séparateur, utilisez trois tirets --- .
Les modificateurs d'accélérateur sont utilisés comme indicateurs visuels mais n'ont pas d'impact matériel car la liaison des touches est effectuée dans l'écouteur d'événement.
Une lettre majuscule implique que l'accélérateur est modifié par la touche Shift .
Les accélérateurs supplémentaires sont Meta , Control , Option , chacun séparé par des virgules. Si l’une d’elles n’est pas applicable à une plateforme, elle sera simplement ignorée.
Sur MacOS, Meta est identique à Command .
Si vous souhaitez désactiver un élément de menu, préfixez simplement l'élément avec le ! personnage. Cela fera apparaître l'élément désactivé lors du rendu du menu système.
Nous pensons que les menus imbriqués sont un anti-modèle. Nous ne les utilisons pas. Si vous avez un argument solide en leur faveur et une pull request très simple qui les fait fonctionner, nous pouvons les considérer.
Lorsqu'un élément de menu est activé, il déclenche l'événement menuItemSelected dans le code frontal, vous pouvez ensuite communiquer avec votre code backend si vous le souhaitez à partir de là.
Par exemple, si l'élément Apple est sélectionné dans le menu Other ...
window . addEventListener ( 'menuItemSelected' , event => {
assert ( event . detail . parent === 'Other' )
assert ( event . detail . title === 'Apple' )
} )| Argument | Taper | Défaut | Facultatif | Description |
|---|---|---|---|---|
| choix | objet | FAUX | un objet d'options | |
| options.valeur | chaîne | FAUX | la disposition des menus | |
| options.index | nombre | FAUX | la fenêtre à cibler (le cas échéant) |
| Valeur de retour | Taper | Description |
|---|---|---|
| Non spécifié | Promesse |
reload() Il s'agit d'une FunctionDeclaration nommée reload dans runtime.js , elle est exportée mais non documentée.
