socket api Download - socket api -Quellcode herunterladen

socket api

Andere Kategorien

1.0.0

Herunterladen

Bluetooth

Eine plattformübergreifende High-Level-API für Bluetooth Pub-Sub

`Bluetooth` (erweitert `EventEmitter` )

Erstellen Sie eine Instanz eines Bluetooth-Dienstes.

`constructor(serviceId)`

Konstruktor ist eine Beispieleigenschaft, die auf true gesetzt ist. Erstellt einen neuen Dienst mit Schlüssel-Wert-Paaren

Argument	Typ	Standard	Optional	Beschreibung
Service-ID	Zeichenfolge		FALSCH	Zur Bestimmung des Typs wird ein Standardwert angegeben

`start()`

Starten Sie den Bluetooth-Dienst.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`subscribe(id )`

Beginnen Sie mit der Suche nach veröffentlichten Werten, die einer bekannten UUID entsprechen. Sobald Sie eine UUID abonniert haben, werden Ereignisse ausgegeben, die dieser UUID entsprechen. Um diese Ereignisse zu empfangen, können Sie beispielsweise einen Ereignis-Listener hinzufügen ...

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

Argument	Typ	Standard	Optional	Beschreibung
Ausweis	Zeichenfolge		FALSCH	Eine bekannte UUID

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`publish(id, value)`

Beginnen Sie mit der Werbung für einen neuen Wert für eine bekannte UUID

Argument	Typ	Standard	Optional	Beschreibung
Ausweis	Zeichenfolge		FALSCH	Eine bekannte UUID
Wert	Zeichenfolge		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

Puffer

Externe Dokumente: https://nodejs.org/api/buffer.html#buffer_class_buffer

Das Puffermodul von node.js für den Browser.

Puffer

Wenn Buffer.TYPED_ARRAY_SUPPORT : === true Uint8Array-Implementierung verwenden (am schnellsten) === false Warnung ausgeben und die Verwendung von buffer v4.x empfehlen, der über eine Objektimplementierung verfügt (am kompatibelsten, sogar IE6)

Browser, die typisierte Arrays unterstützen, sind IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Wir berichten, dass der Browser keine typisierten Arrays unterstützt, wenn sie nicht mithilfe von proto in Unterklassen unterteilt werden können. In Firefox 4-29 fehlt die Unterstützung für das Hinzufügen neuer Eigenschaften zu Uint8Array (siehe: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 bietet keine Unterstützung für Proto und verfügt über eine fehlerhafte typisierte Array-Implementierung.

undefiniert

Wenn Buffer.TYPED_ARRAY_SUPPORT : === true Uint8Array-Implementierung verwenden (am schnellsten) === false Warnung ausgeben und die Verwendung von buffer v4.x empfehlen, der über eine Objektimplementierung verfügt (am kompatibelsten, sogar IE6)

Browser, die typisierte Arrays unterstützen, sind IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Wir berichten, dass der Browser keine typisierten Arrays unterstützt, wenn sie nicht mithilfe von proto in Unterklassen unterteilt werden können. In Firefox 4-29 fehlt die Unterstützung für das Hinzufügen neuer Eigenschaften zu Uint8Array (siehe: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 bietet keine Unterstützung für Proto und verfügt über eine fehlerhafte typisierte Array-Implementierung.

undefiniert

Wenn Buffer.TYPED_ARRAY_SUPPORT : === true Uint8Array-Implementierung verwenden (am schnellsten) === false Warnung ausgeben und die Verwendung von buffer v4.x empfehlen, der über eine Objektimplementierung verfügt (am kompatibelsten, sogar IE6)

Browser, die typisierte Arrays unterstützen, sind IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Wir berichten, dass der Browser keine typisierten Arrays unterstützt, wenn sie nicht mithilfe von proto in Unterklassen unterteilt werden können. In Firefox 4-29 fehlt die Unterstützung für das Hinzufügen neuer Eigenschaften zu Uint8Array (siehe: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 bietet keine Unterstützung für Proto und verfügt über eine fehlerhafte typisierte Array-Implementierung.

undefiniert

Wenn Buffer.TYPED_ARRAY_SUPPORT : === true Uint8Array-Implementierung verwenden (am schnellsten) === false Warnung ausgeben und die Verwendung von buffer v4.x empfehlen, der über eine Objektimplementierung verfügt (am kompatibelsten, sogar IE6)

Browser, die typisierte Arrays unterstützen, sind IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.

Wir berichten, dass der Browser keine typisierten Arrays unterstützt, wenn sie nicht mithilfe von proto in Unterklassen unterteilt werden können. In Firefox 4-29 fehlt die Unterstützung für das Hinzufügen neuer Eigenschaften zu Uint8Array (siehe: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 bietet keine Unterstützung für Proto und verfügt über eine fehlerhafte typisierte Array-Implementierung.

undefiniert

Generieren Sie kryptografisch starke Zufallswerte im buffer

Argument	Typ	Standard	Optional	Beschreibung
Puffer	TypedArray		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	TypedArray

RANDOM_BYTES_QUOTA

Maximale Gesamtgröße zufälliger Bytes pro Seite

MAX_RANDOM_BYTES

Maximale Gesamtgröße für zufällige Bytes.

MAX_RANDOM_BYTES_PAGES

Maximale Gesamtmenge der pro Seite zugewiesenen Bytes (Max/Kontingent)

`randomBytes(size)`

Generieren Sie zufällige Bytes size .

Argument	Typ	Standard	Optional	Beschreibung
Größe	Nummer		FALSCH	Die Anzahl der zu generierenden Bytes. Die Größe darf nicht größer als 2**31 - 1 sein.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Puffer	Ein Versprechen, das mit einer Instanz von socket.Buffer mit zufälligen Bytes aufgelöst wird.

`createDigest(algorithm, message)`

Argument	Typ	Standard	Optional	Beschreibung
Algorithmus	Zeichenfolge		FALSCH	`SHA-1`
Nachricht	Puffer \| TypedArray \| Datenansicht		FALSCH	Eine Instanz von socket.Buffer, TypedArray oder Dataview.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen	Ein Versprechen, das mit einer Instanz von socket.Buffer mit dem Hash aufgelöst wird.

Dgram

Dieses Modul stellt eine Implementierung von UDP-Datagramm-Sockets bereit. Es stellt (noch) keine der Multicast-Methoden oder -Eigenschaften bereit.

`ERR_SOCKET_ALREADY_BOUND` (erweitert `SocketError` )

Wird ausgelöst, wenn ein Socket bereits gebunden ist.

`ERR_SOCKET_DGRAM_IS_CONNECTED` (erweitert `SocketError` )

Wird ausgelöst, wenn der Socket bereits angeschlossen ist.

`ERR_SOCKET_DGRAM_NOT_CONNECTED` (erweitert `SocketError` )

Wird ausgelöst, wenn der Socket nicht angeschlossen ist.

`ERR_SOCKET_DGRAM_NOT_RUNNING` (erweitert `SocketError` )

Wird ausgelöst, wenn der Socket nicht ausgeführt wird (nicht gebunden oder verbunden).

`ERR_SOCKET_BAD_TYPE` (erweitert `TypeError` )

Wird ausgelöst, wenn in einem Argument ein fehlerhafter Socket-Typ verwendet wird.

`ERR_SOCKET_BAD_PORT` (erweitert `RangeError` )

Wird ausgelöst, wenn ein fehlerhafter Port angegeben wird.

`createSocket(options, callback)`

Erstellt eine Socket Instanz. Wenn ()

Argument	Typ	Standard	Optional	Beschreibung
Optionen	Zeichenfolge \| Objekt		FALSCH	entweder eine Zeichenfolge („udp4“ oder „udp6“) oder ein Optionsobjekt
Optionen.Typ	Zeichenfolge		WAHR	Die Steckdosenfamilie. Muss entweder „udp4“ oder „udp6“ sein. Erforderlich.
Optionen.reuseAddr	Boolescher Wert	FALSCH	WAHR	Wenn true, verwendet socket.bind() die Adresse wieder, auch wenn ein anderer Prozess bereits einen Socket daran gebunden hat. Standard: false.
options.ipv6Only	Boolescher Wert	FALSCH	WAHR	Wenn Sie ipv6Only auf true setzen, wird die Dual-Stack-Unterstützung deaktiviert, d. h. durch die Bindung an die Adresse :: wird 0.0.0.0 nicht gebunden. Standard: false.
Optionen.recvBufferSize	Nummer		WAHR	Legt den SO_RCVBUF-Socketwert fest.
Optionen.sendBufferSize	Nummer		WAHR	Legt den SO_SNDBUF-Socketwert fest.
Optionen.signal	AbortSignal		WAHR	Ein AbortSignal, das zum Schließen eines Sockets verwendet werden kann.
Rückruf	Funktion		WAHR	Wird als Listener für „Nachrichten“-Ereignisse angehängt. Optional.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Buchse

`Socket` (erweitert `EventEmitter` )

Neue Instanzen von dgram.Socket werden mit dgram.createSocket() erstellt. Das Schlüsselwort new darf nicht zum Erstellen von dgram.Socket-Instanzen verwendet werden.

`bind(port, address, callback)`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketbindport-address-callback

Lauschen Sie auf Datagrammnachrichten an einem benannten Port und einer optionalen Adresse. Wenn keine Adresse angegeben ist, versucht das Betriebssystem, alle Adressen abzuhören. Sobald die Bindung abgeschlossen ist, wird ein „Listening“-Ereignis ausgegeben und die optionale Rückruffunktion aufgerufen.

Wenn die Bindung fehlschlägt, wird ein Fehlerereignis ausgegeben.

Argument	Typ	Optional	Beschreibung
Hafen	Nummer	FALSCH	Der Port, auf dem auf Nachrichten gewartet werden soll
Adresse	Zeichenfolge	FALSCH	Die Adresse, an die gebunden werden soll (0.0.0.0)
Rückruf	Funktion	FALSCH	Ohne Parameter. Wird aufgerufen, wenn die Bindung abgeschlossen ist.

`connect(port, host, connectListener)`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketconnectport-address-callback

Ordnet den dgram.Socket einer Remote-Adresse und einem Remote-Port zu. Jede von diesem Handle gesendete Nachricht wird automatisch an dieses Ziel gesendet. Außerdem empfängt der Socket nur Nachrichten von diesem Remote-Peer. Der Versuch, connect() für einen bereits verbundenen Socket aufzurufen, führt zu einer ERR_SOCKET_DGRAM_IS_CONNECTED-Ausnahme. Wenn keine Adresse angegeben wird, wird standardmäßig „127.0.0.1“ (für UDP4-Sockets) oder „::1“ (für UDP6-Sockets) verwendet. Sobald die Verbindung hergestellt ist, wird ein „connect“-Ereignis ausgegeben und die optionale Callback-Funktion aufgerufen. Im Fehlerfall wird der Callback aufgerufen oder, falls dies fehlschlägt, ein „error“-Ereignis ausgegeben.

Argument	Typ	Optional	Beschreibung
Hafen	Nummer	FALSCH	Port, mit dem sich der Client verbinden soll.
Gastgeber	Zeichenfolge	WAHR	Host, zu dem der Client eine Verbindung herstellen soll.
connectListener	Funktion	WAHR	Gemeinsamer Parameter von socket.connect()-Methoden. Wird einmalig als Listener für das „connect“-Ereignis hinzugefügt.

`disconnect()`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketdisconnect

Eine synchrone Funktion, die einen verbundenen dgram.Socket von seiner Remote-Adresse trennt. Der Versuch, „disconnect()“ für einen ungebundenen oder bereits getrennten Socket aufzurufen, führt zu einer ERR_SOCKET_DGRAM_NOT_CONNECTED-Ausnahme.

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

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

Sendet ein Datagramm an den Socket. Für verbindungslose Sockets müssen der Zielport und die Zieladresse angegeben werden. Verbundene Sockets hingegen verwenden ihren zugehörigen Remote-Endpunkt, sodass die Port- und Adressargumente nicht festgelegt werden dürfen.

Das Argument msg enthält die zu sendende Nachricht. Je nach Art kann es zu unterschiedlichem Verhalten kommen. Wenn msg ein Puffer, ein beliebiges TypedArray oder eine Datenansicht ist, geben Offset und Länge den Offset innerhalb des Puffers an, an dem die Nachricht beginnt, bzw. die Anzahl der Bytes in der Nachricht. Wenn msg ein String ist, wird er automatisch in einen Puffer mit „utf8“-Kodierung konvertiert. Bei Nachrichten, die Multibyte-Zeichen enthalten, werden Offset und Länge anhand der Bytelänge und nicht anhand der Zeichenposition berechnet. Wenn msg ein Array ist, dürfen Offset und Länge nicht angegeben werden.

Das Adressargument ist eine Zeichenfolge. Wenn der Wert von „Adresse“ ein Hostname ist, wird DNS verwendet, um die Adresse des Hosts aufzulösen. Wenn die Adresse nicht angegeben wird oder anderweitig null ist, wird standardmäßig „127.0.0.1“ (für UDP4-Sockets) oder „::1“ (für UDP6-Sockets) verwendet.

Wenn der Socket nicht zuvor mit einem Bindungsaufruf gebunden wurde, wird dem Socket eine zufällige Portnummer zugewiesen und an die Adresse „alle Schnittstellen“ gebunden („0.0.0.0“ für UDP4-Sockets, „::0“ für UDP6-Sockets). .)

Eine optionale Rückruffunktion kann angegeben werden, um DNS-Fehler zu melden oder um zu bestimmen, wann die Wiederverwendung des Buf-Objekts sicher ist. DNS-Suchen verzögern die Sendezeit um mindestens einen Tick der Node.js-Ereignisschleife.

Die einzige Möglichkeit, sicher zu wissen, dass das Datagramm gesendet wurde, ist die Verwendung eines Rückrufs. Wenn ein Fehler auftritt und ein Rückruf gegeben wird, wird der Fehler als erstes Argument an den Rückruf übergeben. Wenn kein Rückruf angegeben wird, wird der Fehler als „Error“-Ereignis für das Socket-Objekt ausgegeben.

Offset und Länge sind optional, aber beide müssen festgelegt werden, wenn einer von beiden verwendet wird. Sie werden nur unterstützt, wenn das erste Argument ein Buffer, ein TypedArray oder ein DataView ist.

Argument	Typ	Optional	Beschreibung
Nachricht	Puffer \| TypedArray \| Datenansicht \| Zeichenfolge \| Array	FALSCH	Zu sendende Nachricht.
versetzt	ganze Zahl	WAHR	Offset im Puffer, an dem die Nachricht beginnt.
Länge	ganze Zahl	WAHR	Anzahl der Bytes in der Nachricht.
Hafen	ganze Zahl	WAHR	Zielport.
Adresse	Zeichenfolge	WAHR	Ziel-Hostname oder IP-Adresse.
Rückruf	Funktion	WAHR	Wird aufgerufen, wenn die Nachricht gesendet wurde.

`close(callback)`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketclosecallback

Schließen Sie den zugrunde liegenden Socket und hören Sie auf, darauf auf Daten zu warten. Wenn ein Rückruf bereitgestellt wird, wird dieser als Listener für das Ereignis „close“ hinzugefügt.

Argument	Typ	Standard	Optional	Beschreibung
Rückruf	Funktion		WAHR	Wird aufgerufen, wenn die Verbindung hergestellt ist oder ein Fehler auftritt.

`address()`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketaddress

Gibt ein Objekt zurück, das die Adressinformationen für einen Socket enthält. Für UDP-Sockets enthält dieses Objekt Adress-, Familien- und Porteigenschaften.

Diese Methode löst EBADF aus, wenn sie für einen ungebundenen Socket aufgerufen wird.

Rückgabewert	Typ	Beschreibung
socketInfo	Objekt	Informationen zum lokalen Socket
socketInfo.address	Zeichenfolge	Die IP-Adresse des Sockets
socketInfo.port	Zeichenfolge	Der Port des Sockets
socketInfo.family	Zeichenfolge	Die IP-Familie des Sockets

`remoteAddress()`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketremoteaddress

Gibt ein Objekt zurück, das die Adresse, Familie und den Port des Remote-Endpunkts enthält. Diese Methode löst eine ERR_SOCKET_DGRAM_NOT_CONNECTED-Ausnahme aus, wenn der Socket nicht verbunden ist.

Rückgabewert	Typ	Beschreibung
socketInfo	Objekt	Informationen zum Remote-Socket
socketInfo.address	Zeichenfolge	Die IP-Adresse des Sockets
socketInfo.port	Zeichenfolge	Der Port des Sockets
socketInfo.family	Zeichenfolge	Die IP-Familie des Sockets

`setRecvBufferSize(size)`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize

Legt die Socket-Option SO_RCVBUF fest. Legt den maximalen Socket-Empfangspuffer in Bytes fest.

Argument	Typ	Standard	Optional	Beschreibung
Größe	Nummer		FALSCH	Die Größe des neuen Empfangspuffers

`setSendBufferSize(size)`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize

Legt die Socket-Option SO_SNDBUF fest. Legt den maximalen Socket-Sendepuffer in Bytes fest.

Argument	Typ	Standard	Optional	Beschreibung
Größe	Nummer		FALSCH	Die Größe des neuen Sendepuffers

`getRecvBufferSize()`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize

`getSendBufferSize()`

Externe Dokumente: https://nodejs.org/api/dgram.html#socketgetsendbuffersize

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Nummer	Die Sendepuffergröße des SO_SNDBUF-Sockets in Bytes.

DNS

Dieses Modul ermöglicht die Namensauflösung. Verwenden Sie es beispielsweise, um IP-Adressen von Hostnamen nachzuschlagen. Obwohl es nach dem Domain Name System (DNS) benannt ist, wird für Suchvorgänge nicht immer das DNS-Protokoll verwendet. dns.lookup() nutzt die Betriebssystemfunktionen, um die Namensauflösung durchzuführen. Möglicherweise muss keine Netzwerkkommunikation durchgeführt werden. Um die Namensauflösung wie andere Anwendungen auf demselben System durchzuführen, verwenden Sie dns.lookup().

`lookup(hostname, opts, cb)`

Externe Dokumente: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback

Löst einen Hostnamen (z. B. example.org ) in den ersten gefundenen A- (IPv4) oder AAAA- (IPv6) Datensatz auf. Alle Optionseigenschaften sind optional. Wenn „Optionen“ eine Ganzzahl ist, muss sie 4 oder 6 sein – wenn „Optionen“ 0 ist oder nicht angegeben wird, werden sowohl IPv4- als auch IPv6-Adressen zurückgegeben, wenn sie gefunden werden.

Von der node.js-Website ...

Wenn die Option „all“ auf „true“ gesetzt ist, ändern sich die Argumente für den Rückruf in (err, Adressen), wobei Adressen ein Array von Objekten mit den Eigenschaften Adresse und Familie sind.

Im Fehlerfall ist err ein Fehlerobjekt, wobei err.code der Fehlercode ist. Beachten Sie, dass err.code nicht nur dann auf „ENOTFOUND“ gesetzt wird, wenn der Hostname nicht existiert, sondern auch, wenn die Suche aus anderen Gründen fehlschlägt, beispielsweise weil keine Dateideskriptoren verfügbar sind. dns.lookup() hat nicht unbedingt etwas mit dem DNS-Protokoll zu tun. Die Implementierung verwendet eine Betriebssystemfunktion, die Namen mit Adressen verknüpfen kann und umgekehrt. Diese Implementierung kann subtile, aber wichtige Auswirkungen auf das Verhalten jedes Node.js-Programms haben. Bitte nehmen Sie sich etwas Zeit, um den Abschnitt „Überlegungen zur Implementierung“ zu lesen, bevor Sie dns.lookup() verwenden.

Argument	Typ	Standard	Optional	Beschreibung
Hostname	Zeichenfolge		FALSCH	Der aufzulösende Hostname.
optiert	Objekt		WAHR	Ein Optionsobjekt.
opts.family	Zahl \| Zeichenfolge	0	FALSCH	Die Plattenfamilie. Muss 4, 6 oder 0 sein. Aus Gründen der Abwärtskompatibilität werden „IPv4“ und „IPv6“ als 4 bzw. 6 interpretiert. Der Wert 0 gibt an, dass sowohl IPv4- als auch IPv6-Adressen zurückgegeben werden. Standard: 0.
cb	Funktion		FALSCH	Die Funktion, die nach Abschluss der Methode aufgerufen werden soll.

DNS.promises

Dieses Modul ermöglicht die Namensauflösung. Verwenden Sie es beispielsweise, um IP-Adressen von Hostnamen nachzuschlagen. Obwohl es nach dem Domain Name System (DNS) benannt ist, wird für Suchvorgänge nicht immer das DNS-Protokoll verwendet. dns.lookup() nutzt die Betriebssystemfunktionen, um die Namensauflösung durchzuführen. Möglicherweise muss keine Netzwerkkommunikation durchgeführt werden. Um die Namensauflösung wie andere Anwendungen auf demselben System durchzuführen, verwenden Sie dns.lookup().

`lookup(hostname, opts)`

Externe Dokumente: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

Argument	Typ	Standard	Optional	Beschreibung
Hostname	Zeichenfolge		FALSCH	Der aufzulösende Hostname.
optiert	Objekt		WAHR	Ein Optionsobjekt.
opts.family	Zahl \| Zeichenfolge	0	FALSCH	Die Plattenfamilie. Muss 4, 6 oder 0 sein. Aus Gründen der Abwärtskompatibilität werden „IPv4“ und „IPv6“ als 4 bzw. 6 interpretiert. Der Wert 0 gibt an, dass sowohl IPv4- als auch IPv6-Adressen zurückgegeben werden. Standard: 0.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

Dateisystem

Dieses Modul ermöglicht die Interaktion mit dem Dateisystem nach dem Vorbild von Standard-POSIX-Funktionen.

Die Anwendungssandbox schränkt den Zugriff auf das Dateisystem ein. Weitere Informationen finden Sie in der Dokumentation zur Anwendungssandbox: https://sockets.sh/guides/#working-with-the-file-system-on-ios

So verwenden Sie die versprochenen APIs:

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

So verwenden Sie die Callback- und Async-APIs:

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

`access(path, mode , callback)`

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

Überprüfen Sie asynchron den Zugriff auf eine Datei für einen bestimmten Modus und rufen Sie bei Erfolg oder Fehler callback auf.

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Modus	Zeichenfolge	F_OK(0)	WAHR
Rückruf	Funktion(err, fd)		FALSCH

`chmod(path, mode, callback)`

Externe Dokumente: https://nodejs.org/api/fs.html#fschmodpath-mode-callback

Ändert asynchron die Berechtigungen einer Datei. Dem Abschlussrückruf werden außer einer möglichen Ausnahme keine Argumente übergeben

Argument	Typ	Optional
Weg	Zeichenfolge \| Puffer \| URL	FALSCH
Modus	Nummer	FALSCH
Rückruf	Funktion(fehler)	FALSCH

`close(fd, callback)`

Schließen Sie einen Dateideskriptor asynchron und rufen Sie bei Erfolg oder Fehler callback auf.

Argument	Typ	Standard	Optional	Beschreibung
fd	Nummer		FALSCH
Rückruf	Funktion(fehler)		WAHR

`copyFile()`

Dies ist eine FunctionDeclaration mit dem Namen copyFile in fs/index.js , sie wird exportiert, aber nicht dokumentiert.

`createReadStream(path, options)`

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

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	fs.ReadStream

`createWriteStream(path, options)`

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

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	fs.WriteStream

`fstat(fd, options, callback)`

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

Ruft den Rückruf mit dem <fs.Stats> für den Dateideskriptor auf. Weitere Einzelheiten finden Sie in der POSIX fstat(2)-Dokumentation.

Argument	Typ	Optional	Beschreibung
fd	Nummer	FALSCH	Ein Dateideskriptor.
Optionen	Objekt	WAHR	Ein Optionsobjekt.
Rückruf	Funktion	FALSCH	Die nach Abschluss aufzurufende Funktion.

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

Öffnen Sie asynchron eine Datei und rufen Sie bei Erfolg oder Fehler callback auf.

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Flaggen	Zeichenfolge	R	WAHR
Modus	Zeichenfolge	0o666	WAHR
Rückruf	Funktion(err, fd)		FALSCH

`opendir(path, options, callback)`

Öffnen Sie asynchron ein Verzeichnis und rufen Sie bei Erfolg oder Fehler callback auf.

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.withFileTypes	Boolescher Wert	FALSCH	WAHR
Rückruf	Funktion(err, fd)		FALSCH

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

Asynchrones Lesen aus einem offenen Dateideskriptor.

Argument	Typ	Optional	Beschreibung
fd	Nummer	FALSCH
Puffer	Objekt \| Puffer \| TypedArray	FALSCH	Der Puffer, in den die Daten geschrieben werden.
versetzt	Nummer	FALSCH	Die Position im Puffer, an die die Daten geschrieben werden sollen.
Länge	Nummer	FALSCH	Die Anzahl der zu lesenden Bytes.
Position	Zahl \| BigInt \| null	FALSCH	Gibt an, wo in der Datei mit dem Lesen begonnen werden soll. Wenn position null oder -1 ist, werden Daten von der aktuellen Dateiposition gelesen und die Dateiposition aktualisiert. Wenn Position eine Ganzzahl ist, bleibt die Dateiposition unverändert.
Rückruf	Funktion(err, bytesRead, buffer)	FALSCH

`readdir(path, options, callback)`

Alle Einträge in einem Verzeichnis asynchron lesen.

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.withFileTypes	Boolescher Wert	FALSCH	WAHR
Rückruf	Funktion(Fehler, Puffer)		FALSCH

`readFile(path, options, callback)`

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL \| Nummer		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.Flag	Zeichenfolge	R	WAHR
Optionen.signal	AbortSignal		WAHR
Rückruf	Funktion(Fehler, Puffer)		FALSCH

`stat(path, options, callback)`

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL \| Nummer		FALSCH	Dateiname oder Dateideskriptor
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.Flag	Zeichenfolge	R	WAHR
Optionen.signal	AbortSignal		WAHR
Rückruf	Funktion(Fehler, Daten)		FALSCH

`writeFile(path, data, options, callback)`

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL \| Nummer		FALSCH	Dateiname oder Dateideskriptor
Daten	Zeichenfolge \| Puffer \| TypedArray \| Datenansicht \| Objekt		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.Modus	Zeichenfolge	0o666	WAHR
Optionen.Flag	Zeichenfolge	w	WAHR
Optionen.signal	AbortSignal		WAHR
Rückruf	Funktion(fehler)		FALSCH

`writev()`

Dies ist eine FunctionDeclaration mit dem Namen writev in fs/index.js , sie wird exportiert, aber nicht dokumentiert.

FS.verspricht

`access(path, mode, options)`

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

Überprüfen Sie den Zugriff auf eine Datei asynchron.

Argument	Typ	Optional
Weg	Zeichenfolge \| Puffer \| URL	FALSCH
Modus	Zeichenfolge	WAHR
Optionen	Objekt	WAHR

`chmod(path, mode)`

Externe Dokumente: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Modus	Nummer		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`mkdir(path, options)`

Erstellt asynchron ein Verzeichnis.

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge		FALSCH	Der Weg zum Schaffen
Optionen	Objekt		FALSCH	Das optionale Optionsargument kann eine Ganzzahl sein, die den Modus angibt (Berechtigung und Sticky-Bits), oder ein Objekt mit einer Moduseigenschaft und einer rekursiven Eigenschaft, die angibt, ob übergeordnete Verzeichnisse erstellt werden sollen. Der Aufruf von fs.mkdir(), wenn path ein vorhandenes Verzeichnis ist, führt nur dann zu einem Fehler, wenn recursive den Wert false hat.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Primise	Bei Erfolg wird undefiniert ausgeführt, wenn „recursive“ „false“ ist, oder der erste erstellte Verzeichnispfad, wenn „recursive“ „true“ ist.

`open(path, flags, mode)`

Externe Dokumente: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode

Öffnen Sie eine Datei asynchron.

Argument	Typ	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL	FALSCH
Flaggen	Zeichenfolge	FALSCH	Standard: 'r'
Modus	Zeichenfolge	FALSCH	Standard: 0o666

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`opendir(path, options)`

Externe Dokumente: https://nodejs.org/api/fs.html#fspromisesopendirpath-options

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.bufferSize	Nummer	32	WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Promise<FileSystem,Dir>

`readdir(path, options)`

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

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge	utf8	WAHR
Optionen.withFileTypes	Boolescher Wert	FALSCH	WAHR

`readFile(path, options)`

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

Argument	Typ	Standard	Optional
Weg	Zeichenfolge		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge \| null	null	WAHR
Optionen.Flag	Zeichenfolge	R	WAHR
Optionen.Signal	AbortSignal		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<Puffer	Zeichenfolge>

`stat(path, options)`

Externe Dokumente: https://nodejs.org/api/fs.html#fspromisesstatpath-options

Argument	Typ	Standard	Optional
Weg	Zeichenfolge \| Puffer \| URL		FALSCH
Optionen	Objekt		WAHR
Optionen.bigint	Boolescher Wert	FALSCH	WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`writeFile(path, data, options)`

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

Argument	Typ	Standard	Optional	Beschreibung
Weg	Zeichenfolge \| Puffer \| URL \| FileHandle		FALSCH	Dateiname oder FileHandle
Daten	Zeichenfolge \| Puffer \| Array \| Datenansicht \| TypedArray \| Strom		FALSCH
Optionen	Objekt		WAHR
Optionen.Kodierung	Zeichenfolge \| null	utf8	FALSCH
Optionen.Modus	Nummer	0o666	FALSCH
Optionen.Flag	Zeichenfolge	w	FALSCH
Optionen.Signal	AbortSignal		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

FS.Stream

DEFAULT_STREAM_HIGH_WATER_MARK

Dies ist eine VariableDeclaration mit dem Namen DEFAULT_STREAM_HIGH_WATER_MARK in fs/stream.js . Sie wird exportiert, aber nicht dokumentiert.

`ReadStream` (erweitert `Readable` )

Ein Readable Stream für ein FileHandle .

`constructor()`

Konstruktor der ReadStream Klasse

`setHandle(handle)`

Legt das Dateihandle für den ReadStream fest.

Argument	Typ	Standard	Optional	Beschreibung
handhaben	FileHandle		FALSCH

`highWaterMark()`

Die maximale Puffergröße für den ReadStream.

`path()`

Relativer oder absoluter Pfad des zugrunde liegenden FileHandle .

`pending()`

true , wenn sich der Stream im Status „Ausstehend“ befindet.

`emit()`

Behandelt die Einstellung shouldEmitClose von options.emitClose im Konstruktor.

`WriteStream` (erweitert `Writable` )

Ein Writable Stream für ein FileHandle .

`constructor()`

Konstruktor der WriteStream -Klasse

`setHandle(handle)`

Legt das Dateihandle für den WriteStream fest.

Argument	Typ	Standard	Optional	Beschreibung
handhaben	FileHandle		FALSCH

`highWaterMark()`

Die maximale Puffergröße für den Writetream.

`path()`

Relativer oder absoluter Pfad des zugrunde liegenden FileHandle .

`pending()`

true , wenn sich der Stream im Status „Ausstehend“ befindet.

`emit()`

Behandelt die Einstellung shouldEmitClose von options.emitClose im Konstruktor.

FileReadStream

Dies ist eine VariableDeclaration mit dem Namen FileReadStream in fs/stream.js , sie wird exportiert, aber nicht dokumentiert.

FileWriteStream

Dies ist eine VariableDeclaration mit dem Namen FileWriteStream in fs/stream.js , sie wird exportiert, aber nicht dokumentiert.

IPC

Dies ist eine Low-Level-API, die Sie nicht benötigen, es sei denn, Sie implementieren eine Bibliothek zusätzlich zum Socket SDK. Eine Socket SDK-App verfügt über zwei oder drei Prozesse.

Der Render -Prozess, die Benutzeroberfläche, auf der HTML, CSS und JS ausgeführt werden.
Der Bridge Prozess, die dünne Codeschicht, die alles verwaltet.
Der Main für Apps, die umfangreichere Rechenaufgaben ausführen müssen. Und im Gegensatz zu Elektronen ist es optional.

Der Bridge-Prozess verwaltet den Render- und Main-Prozess und kann auch Daten zwischen ihnen vermitteln.

Der Bindungsprozess nutzt Standardeingaben und -ausgaben als Kommunikationsmittel. Auf das Schreibende der Pipe geschriebene Daten werden vom Betriebssystem gepuffert, bis sie vom Leseende der Pipe gelesen werden.

Das IPC-Protokoll verwendet ein einfaches URI-ähnliches Schema. Daten werden als ArrayBuffers übergeben.

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

`postMessage()`

Dies ist eine FunctionDeclaration mit dem Namen postMessage in ipc.js , sie wird exportiert, aber nicht dokumentiert.

OK

Stellt einen OK-IPC-Status dar.

FEHLER

Stellt einen ERROR IPC-Status dar.

TIME-OUT

Timeout in Millisekunden für IPC-Anfragen.

kDebugEnabled

Symbol für die ipc.debug.enabled -Eigenschaft

`parseSeq(seq, options)`

Analysiert seq als ganzzahligen Wert

Argument	Typ	Standard	Optional
seq	Zeichenfolge \| Nummer		FALSCH
Optionen	Objekt		WAHR
Optionen.bigint	Boolescher Wert	FALSCH	FALSCH

`debug(enable)`

Wenn debug.enabled === true , wird die Debug-Ausgabe auf der Konsole ausgegeben.

Argument	Typ	Standard	Optional	Beschreibung
aktivieren	Boolescher Wert		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Boolescher Wert

`Message` (erweitert `URL` )

Ein Container für eine IPC-Nachricht basierend auf einem ipc:// -URI-Schema.

`PROTOCOL()`

Das erwartete Protokoll für eine IPC-Nachricht.

`from(input, params)`

Erstellt eine Message Instanz aus einer Vielzahl von Eingaben.

Argument	Typ	Standard	Optional	Beschreibung
Eingang	Zeichenfolge \| URL \| Nachricht \| Puffer \| Objekt		FALSCH
Parameter	Objekt \| Zeichenfolge \| URLSearchParams		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Nachricht

`isValidInput(input)`

Prädikat, um zu bestimmen, ob input zum Erstellen einer neuen Message Instanz gültig ist.

Argument	Typ	Standard	Optional	Beschreibung
Eingang	Zeichenfolge \| URL \| Nachricht \| Puffer \| Objekt		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Boolescher Wert

`constructor(input)`

Konstruktor der Message .

Argument	Typ	Standard	Optional	Beschreibung
Eingang	Zeichenfolge \| URL		FALSCH

`command()`

Berechneter IPC-Nachrichtenname.

`name()`

Berechneter IPC-Nachrichtenname.

`id()`

Berechneter id Wert für den Befehl.

`seq()`

Berechneter seq Wert (Sequenzwert) für den Befehl.

`value()`

Berechneter Nachrichtenwert, der möglicherweise in Nachrichtenparametern angegeben wird. Dieser Wert wird automatisch dekodiert, aber nicht als JSON behandelt.

`index()`

Berechneter index für den Befehl, der sich möglicherweise auf den Fensterindex bezieht, auf den der Befehl beschränkt ist oder von dem er stammt. Wenn in den Nachrichtenparametern nichts angegeben ist, ist dieser Wert standardmäßig auf -1 gesetzt.

`json()`

Berechneter Wert, geparst als JSON. Dieser Wert ist null wenn der Wert nicht vorhanden ist oder es sich um ein ungültiges JSON handelt.

`params()`

Berechnetes schreibgeschütztes Objekt von Nachrichtenparametern.

`entries()`

Gibt berechnete Parameter als Einträge zurück

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Array<Array<string,mixed>>

`set(key, value)`

Legen Sie einen value mit key fest.

Argument	Typ	Standard	Optional	Beschreibung
Schlüssel	Zeichenfolge		FALSCH
Wert	gemischt		FALSCH

`get(key, defaultValue)`

Rufen Sie einen Parameterwert per key ab.

Argument	Typ	Standard	Optional	Beschreibung
Schlüssel	Zeichenfolge		FALSCH
Standardwert	gemischt		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	gemischt

`delete(key)`

Löschen Sie einen Parameter mit key .

Argument	Typ	Standard	Optional	Beschreibung
Schlüssel	Zeichenfolge		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Boolescher Wert

`keys()`

Berechnete Parameterschlüssel.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Array

`values()`

Berechnete Parameterwerte.

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Array

`has(key)`

Prädikat, um zu bestimmen, ob der key in Parametern vorhanden ist.

Argument	Typ	Standard	Optional	Beschreibung
Schlüssel	Zeichenfolge		FALSCH

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Boolescher Wert

`toJSON()`

Konvertiert eine Message Instanz in ein einfaches JSON-Objekt.

Ergebnis

Ein Ergebnistyp, der intern zur Verarbeitung von IPC-Ergebniswerten aus der nativen Ebene verwendet wird, die das Format { err?, data? } . Die data und err für diesen Objekttyp liegen in Tupelform vor und können unter [data?,err?] abgerufen werden.

`from(result, maybeError, maybeSource)`

Erstellt eine Result aus der Eingabe, bei der es sich möglicherweise um ein Objekt wie { err?, data? } handelt. { err?, data? } , eine Error Instanz oder einfach nur data .

Argument	Typ	Optional
Ergebnis	Objekt \| Fehler \| gemischt	WAHR
vielleichtFehler	Fehler	WAHR
vielleichtQuelle	Zeichenfolge	WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Ergebnis

`constructor(err , data , source )`

Konstruktor der Result .

Argument	Typ	Standard	Optional
ähm	Fehler	null	WAHR
Daten	Objekt	null	WAHR
Quelle	Zeichenfolge	undefiniert	WAHR

`length()`

Berechnete Ergebnislänge.

`ready()`

Wartet darauf, dass die native IPC-Ebene bereit ist und auf dem globalen Fensterobjekt verfügbar gemacht wird.

`sendSync(command, params)`

Sendet einen synchronen IPC-Befehl über XHR und gibt bei Erfolg oder Fehler ein Result zurück.

Argument	Typ	Standard	Optional	Beschreibung
Befehl	Zeichenfolge		FALSCH
Parameter	Objekt \| Zeichenfolge		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Ergebnis

`emit(name, value, target , options)`

Geben Sie ein Ereignis aus, das für das window gesendet werden soll.

Argument	Typ	Standard	Optional
Name	Zeichenfolge		FALSCH
Wert	Gemischt		FALSCH
Ziel	Ereignisziel	Fenster	WAHR
Optionen	Objekt		WAHR

`resolve(seq, value)`

Löst eine Anfrage seq mit möglichem Wert auf.

Argument	Typ	Standard	Optional	Beschreibung
seq	Zeichenfolge		FALSCH
Wert	Gemischt		FALSCH

`send(command, value)`

Sendet eine asynchrone IPC-Befehlsanforderung mit Parametern.

Argument	Typ	Standard	Optional	Beschreibung
Befehl	Zeichenfolge		FALSCH
Wert	Gemischt		WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`write(command, params, buffer, options)`

Sendet eine asynchrone IPC-Befehlsanforderung mit Parametern und gepufferten Bytes.

Argument	Typ	Optional
Befehl	Zeichenfolge	FALSCH
Parameter	Objekt	WAHR
Puffer	Puffer \| TypeArray \| ArrayBuffer \| Zeichenfolge \| Array	WAHR
Optionen	Objekt	WAHR

`request(command, params, options)`

Sendet eine asynchrone IPC-Befehlsanforderung mit Parametern, die eine Antwort mit gepufferten Bytes anfordern.

Argument	Typ	Optional
Befehl	Zeichenfolge	FALSCH
Parameter	Objekt	WAHR
Optionen	Objekt	WAHR

`createBinding(domain, ctx)`

Factory zum Erstellen einer Proxy-basierten IPC-API.

Argument	Typ	Optional
Domain	Zeichenfolge	FALSCH
ctx	Funktion \| Objekt	WAHR
ctx.default	Zeichenfolge	WAHR

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Stellvertreter

Betriebssystem

Dieses Modul stellt normalisierte Systeminformationen aller wichtigen Betriebssysteme bereit.

`arch()`

Dies ist eine FunctionDeclaration mit dem Namen arch in os.js , sie wird exportiert, aber nicht dokumentiert.

`networkInterfaces()`

Dies ist eine FunctionDeclaration mit dem Namen networkInterfaces in os.js , sie wird exportiert, aber nicht dokumentiert.

`platform()`

Dies ist eine FunctionDeclaration mit dem Namen platform in os.js Sie wird exportiert, aber nicht dokumentiert.

`type()`

Dies ist eine FunctionDeclaration mit dem Namen type in os.js , sie wird exportiert, aber nicht dokumentiert.

`isWindows()`

Dies ist eine FunctionDeclaration mit dem Namen isWindows in os.js , sie wird exportiert, aber nicht dokumentiert.

`tmpdir()`

Dies ist eine FunctionDeclaration mit dem Namen tmpdir in os.js , sie wird exportiert, aber nicht dokumentiert.

EOL

Dies ist eine VariableDeclaration mit dem Namen EOL in os.js , sie wird exportiert, aber nicht dokumentiert.

Weg

Dies ist eine ClassDeclaration mit dem Namen Path in path/path.js . Sie wird exportiert, aber nicht dokumentiert.

`cwd(opts)`

Berechnet das aktuelle Arbeitsverzeichnis für einen Pfad

Argument	Typ	Standard	Optional	Beschreibung
optiert	Objekt		WAHR
opts.posix Auf `true` setzen, um einen Pfad im POSIX-Stil zu erzwingen	Boolescher Wert		WAHR

`constructor(opts)`

Konstruktor der Path .

Argument	Typ	Optional
optiert	Objekt	WAHR
opts.root	Zeichenfolge	WAHR
opts.base	Zeichenfolge	WAHR
opts.name	Zeichenfolge	WAHR
opts.dir	Zeichenfolge	WAHR
opts.ext	Zeichenfolge	WAHR

`resolve()`

`normalize()`

Verfahren

`homedir()`

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Zeichenfolge	Das Home-Verzeichnis des aktuellen Benutzers.

`exit(code)`

Argument	Typ	Standard	Optional	Beschreibung
Code	Nummer	0	WAHR	Der Exit-Code. Standard: 0.

Laufzeit

Stellt laufzeitspezifische Methoden bereit

aktuelles Fenster

Dies ist eine VariableDeclaration mit dem Namen currentWindow in runtime.js , sie wird exportiert, aber nicht dokumentiert.

debuggen

Dies ist eine VariableDeclaration mit dem Namen debug in runtime.js . Sie wird exportiert, aber nicht dokumentiert.

config

Dies ist eine VariableDeclaration mit dem Namen config in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`send()`

Dies ist eine FunctionDeclaration mit dem Namen send in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`getWindows()`

Dies ist eine FunctionDeclaration mit dem Namen getWindows in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`openExternal()`

Dies ist eine FunctionDeclaration mit dem Namen openExternal in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`exit(options)`

Beendet den Backend-Prozess und anschließend den Renderprozess. Der verwendete Exit-Code ist der endgültige Exit-Code für das Betriebssystem.

Argument	Typ	Standard	Optional	Beschreibung
Optionen	Objekt		FALSCH	ein Optionsobjekt

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`setTitle(options)`

Legt den Titel des Fensters fest (falls zutreffend).

Argument	Typ	Standard	Optional	Beschreibung
Optionen	Objekt		FALSCH	ein Optionsobjekt

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`inspect()`

Dies ist eine FunctionDeclaration mit dem Namen inspect in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`show(opts)`

Argument	Typ	Standard	Optional	Beschreibung
optiert	Objekt		FALSCH	ein Optionsobjekt

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`hide(opts)`

Argument	Typ	Standard	Optional	Beschreibung
optiert	Objekt		FALSCH	ein Optionsobjekt

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`navigate(opts)`

Argument	Typ	Standard	Optional	Beschreibung
optiert	Objekt		FALSCH	ein Optionsobjekt
opts.window	Nummer	aktuelles Fenster	FALSCH	der Index des Fensters
opts.url	Nummer		FALSCH	Der Pfad zur HTML-Datei, die in das Fenster geladen werden soll

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen<ipc.Result>

`setWindowBackgroundColor()`

Dies ist eine FunctionDeclaration mit dem Namen setWindowBackgroundColor in runtime.js , sie wird exportiert, aber nicht dokumentiert.

`setContextMenu(options)`

Öffnet ein natives Kontextmenü.

Argument	Typ	Standard	Optional	Beschreibung
Optionen	Objekt		FALSCH	ein Optionsobjekt

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`setSystemMenuItemEnabled()`

Dies ist eine FunctionDeclaration mit dem Namen setSystemMenuItemEnabled in runtime.js . Sie wurde exportiert, aber nicht dokumentiert.

`setSystemMenu(options)`

Legen Sie das native Menü für die App fest.

Socket Runtime bietet ein minimalistisches DSL, das die Erstellung plattformübergreifender nativer System- und Kontextmenüs erleichtert.

Menüs werden zur Laufzeit erstellt. Sie können entweder im Haupt- oder im Render-Prozess erstellt werden. Sie können durch Aufruf der setSystemMenu -Methode sofort neu erstellt werden.

Die Methode benötigt einen String. Hier ist ein Beispiel für ein Menü. Das Semikolon ist wichtig und zeigt das Ende des Menüs an. Verwenden Sie einen Unterstrich, wenn keine Zugriffstaste vorhanden ist. Modifikatoren sind optional. Und bekannte OS-Menüoptionen wie das Bearbeitungsmenü erhalten automatisch Zugriffstasten, die Sie nicht angeben müssen.

 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;
` )

Trennzeichen

Um ein Trennzeichen zu erstellen, verwenden Sie drei Bindestriche --- .

Beschleunigermodifikatoren

Beschleunigermodifikatoren werden als visuelle Indikatoren verwendet, haben jedoch keine wesentliche Auswirkung, da die eigentliche Tastenzuordnung im Ereignis-Listener erfolgt.

Ein Großbuchstabe bedeutet, dass das Beschleuniger durch die Shift geändert wird.

Weitere Beschleuniger sind Meta , Control , Option , jeweils durch Kommas getrennt. Wenn einer für eine Plattform nicht anwendbar ist, wird er einfach ignoriert.

Unter MacOS ist Meta dasselbe wie Command .

Deaktivierte Elemente

Wenn Sie einen Menüpunkt deaktivieren möchten, stellen Sie ihm einfach das ! voran. Charakter. Dadurch wird das Element beim Rendern des Systemmenüs als deaktiviert angezeigt.

Untermenüs

Wir sind der Meinung, dass verschachtelte Menüs ein Anti-Pattern sind. Wir nutzen sie nicht. Wenn Sie ein starkes Argument dafür und einen sehr einfachen Pull-Request haben, der sie zum Funktionieren bringt, könnten wir sie in Betracht ziehen.

Ereignisbehandlung

Wenn ein Menüelement aktiviert wird, löst es das Ereignis menuItemSelected im Front-End-Code aus. Sie können dann von dort aus mit Ihrem Backend-Code kommunizieren, wenn Sie möchten.

Wenn beispielsweise das Apple Element aus dem Menü Other ausgewählt wird ...

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

Argument	Typ	Optional	Beschreibung
Optionen	Objekt	FALSCH	ein Optionsobjekt
Optionen.Wert	Zeichenfolge	FALSCH	das Menülayout
Optionen.index	Nummer	FALSCH	das Zielfenster (falls zutreffend)

Rückgabewert	Typ	Beschreibung
Nicht angegeben	Versprechen

`reload()`

Dies ist eine FunctionDeclaration mit dem Namen reload in runtime.js , sie wird exportiert, aber nicht dokumentiert.

Strom

Expandieren

Zusätzliche Informationen

Version 1.0.0
Typ Andere Kategorien
Aktualisierungszeit 2025-01-04
Größe 130.88KB
Kommt von Github

Ähnliche Anwendungen

cloud sql jdbc socket factory

2024-11-05
sample node api

2024-11-05
aspera api examples

2024-11-04
evolution api

2024-11-03
Der Quellcode der Kraftstoffrabatt-APP kann erneut geöffnet werden und die Kraftstoff-API-API-API wird zum niedrigsten Preis bereitgestellt.

2022-12-06
Workerman (hochleistungsfähiges PHP-Socket-Framework)

2022-10-31

socket api

Bluetooth

Bluetooth (erweitert EventEmitter )

constructor(serviceId)

start()

subscribe(id )

publish(id, value)

Puffer

Puffer

undefiniert

undefiniert

undefiniert

undefiniert

Puffer

undefiniert

undefiniert

undefiniert

Puffer

undefiniert

undefiniert

undefiniert

Puffer

undefiniert

undefiniert

undefiniert

Puffer

undefiniert

undefiniert

undefiniert

Krypto

webcrypto

getRandomValues(buffer)

RANDOM_BYTES_QUOTA

MAX_RANDOM_BYTES

MAX_RANDOM_BYTES_PAGES

randomBytes(size)

createDigest(algorithm, message)

Dgram

ERR_SOCKET_ALREADY_BOUND (erweitert SocketError )

ERR_SOCKET_DGRAM_IS_CONNECTED (erweitert SocketError )

ERR_SOCKET_DGRAM_NOT_CONNECTED (erweitert SocketError )

ERR_SOCKET_DGRAM_NOT_RUNNING (erweitert SocketError )

ERR_SOCKET_BAD_TYPE (erweitert TypeError )

ERR_SOCKET_BAD_PORT (erweitert RangeError )

createSocket(options, callback)

Socket (erweitert EventEmitter )

bind(port, address, callback)

connect(port, host, connectListener)

disconnect()

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

close(callback)

address()

remoteAddress()

setRecvBufferSize(size)

setSendBufferSize(size)

getRecvBufferSize()

getSendBufferSize()

DNS

lookup(hostname, opts, cb)

DNS.promises

lookup(hostname, opts)

Dateisystem

access(path, mode , callback)

chmod(path, mode, callback)

close(fd, callback)

copyFile()

createReadStream(path, options)

createWriteStream(path, options)

fstat(fd, options, callback)

open(path, flags , mode , callback)

opendir(path, options, callback)

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

readdir(path, options, callback)

readFile(path, options, callback)

stat(path, options, callback)

writeFile(path, data, options, callback)

writev()

FS.verspricht

access(path, mode, options)

chmod(path, mode)

`Bluetooth` (erweitert `EventEmitter` )

`constructor(serviceId)`

`start()`

`subscribe(id )`

`publish(id, value)`

`getRandomValues(buffer)`

`randomBytes(size)`

`createDigest(algorithm, message)`

`ERR_SOCKET_ALREADY_BOUND` (erweitert `SocketError` )

`ERR_SOCKET_DGRAM_IS_CONNECTED` (erweitert `SocketError` )

`ERR_SOCKET_DGRAM_NOT_CONNECTED` (erweitert `SocketError` )

`ERR_SOCKET_DGRAM_NOT_RUNNING` (erweitert `SocketError` )

`ERR_SOCKET_BAD_TYPE` (erweitert `TypeError` )

`ERR_SOCKET_BAD_PORT` (erweitert `RangeError` )

`createSocket(options, callback)`

`Socket` (erweitert `EventEmitter` )

`bind(port, address, callback)`

`connect(port, host, connectListener)`

`disconnect()`

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

`close(callback)`

`address()`

`remoteAddress()`

`setRecvBufferSize(size)`

`setSendBufferSize(size)`

`getRecvBufferSize()`

`getSendBufferSize()`

`lookup(hostname, opts, cb)`

`lookup(hostname, opts)`

`access(path, mode , callback)`

`chmod(path, mode, callback)`

`close(fd, callback)`

`copyFile()`

`createReadStream(path, options)`

`createWriteStream(path, options)`

`fstat(fd, options, callback)`

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

`opendir(path, options, callback)`

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

`readdir(path, options, callback)`

`readFile(path, options, callback)`

`stat(path, options, callback)`

`writeFile(path, data, options, callback)`

`writev()`

`access(path, mode, options)`

`chmod(path, mode)`

`mkdir(path, options)`

`open(path, flags, mode)`

`opendir(path, options)`

`readdir(path, options)`

`readFile(path, options)`

`stat(path, options)`

`writeFile(path, data, options)`

`ReadStream` (erweitert `Readable` )

`constructor()`

`setHandle(handle)`

`highWaterMark()`

`path()`

`pending()`

`emit()`

`WriteStream` (erweitert `Writable` )

`constructor()`

`setHandle(handle)`

`highWaterMark()`

`path()`

`pending()`

`emit()`

`postMessage()`

`parseSeq(seq, options)`

`debug(enable)`

`Message` (erweitert `URL` )

`PROTOCOL()`

`from(input, params)`

`isValidInput(input)`

`constructor(input)`

`command()`

`name()`

`id()`

`seq()`

`value()`