socket api
1.0.0
API lintas platform tingkat tinggi untuk Bluetooth Pub-Sub
Bluetooth (memperluas EventEmitter )Buat instance layanan Bluetooth.
constructor(serviceId) konstruktor adalah contoh properti yang disetel ke true Membuat layanan baru dengan pasangan nilai kunci
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| Id layanan | rangkaian | PALSU | Diberikan nilai default untuk menentukan jenisnya |
start()Mulai layanan bluetooth.
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
subscribe(id )Mulai memindai nilai yang dipublikasikan yang sesuai dengan UUID yang terkenal. Setelah berlangganan UUID, peristiwa yang sesuai dengan UUID tersebut akan dikeluarkan. Untuk menerima acara ini Anda dapat menambahkan pendengar acara, misalnya...
const ble = new Bluetooth ( id )
ble . subscribe ( uuid )
ble . on ( uuid , ( data , details ) => {
// ...do something interesting
} )| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pengenal | rangkaian | PALSU | UUID yang terkenal |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
publish(id, value)Mulai mengiklankan nilai baru untuk UUID yang terkenal
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pengenal | rangkaian | PALSU | UUID yang terkenal | |
| nilai | rangkaian | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
Dokumen eksternal: https://nodejs.org/api/buffer.html#buffer_class_buffer
Modul buffer dari node.js, untuk browser.
Jika Buffer.TYPED_ARRAY_SUPPORT : === true Gunakan implementasi Uint8Array (tercepat) === false Cetak peringatan dan rekomendasikan penggunaan buffer v4.x yang memiliki implementasi Objek (paling kompatibel, bahkan IE6)
Browser yang mendukung array yang diketik adalah IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Kami melaporkan bahwa browser tidak mendukung array yang diketik jika array tersebut tidak dapat disubklasifikasikan menggunakan proto . Firefox 4-29 tidak memiliki dukungan untuk menambahkan properti baru ke Uint8Array (Lihat: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 tidak memiliki dukungan untuk proto dan memiliki implementasi array yang diketik bermasalah.
Jika Buffer.TYPED_ARRAY_SUPPORT : === true Gunakan implementasi Uint8Array (tercepat) === false Cetak peringatan dan rekomendasikan penggunaan buffer v4.x yang memiliki implementasi Objek (paling kompatibel, bahkan IE6)
Browser yang mendukung array yang diketik adalah IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Kami melaporkan bahwa browser tidak mendukung array yang diketik jika array tersebut tidak dapat disubklasifikasikan menggunakan proto . Firefox 4-29 tidak memiliki dukungan untuk menambahkan properti baru ke Uint8Array (Lihat: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 tidak memiliki dukungan untuk proto dan memiliki implementasi array yang diketik bermasalah.
Jika Buffer.TYPED_ARRAY_SUPPORT : === true Gunakan implementasi Uint8Array (tercepat) === false Cetak peringatan dan rekomendasikan penggunaan buffer v4.x yang memiliki implementasi Objek (paling kompatibel, bahkan IE6)
Browser yang mendukung array yang diketik adalah IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Kami melaporkan bahwa browser tidak mendukung array yang diketik jika array tersebut tidak dapat disubklasifikasikan menggunakan proto . Firefox 4-29 tidak memiliki dukungan untuk menambahkan properti baru ke Uint8Array (Lihat: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 tidak memiliki dukungan untuk proto dan memiliki implementasi array yang diketik bermasalah.
Jika Buffer.TYPED_ARRAY_SUPPORT : === true Gunakan implementasi Uint8Array (tercepat) === false Cetak peringatan dan rekomendasikan penggunaan buffer v4.x yang memiliki implementasi Objek (paling kompatibel, bahkan IE6)
Browser yang mendukung array yang diketik adalah IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+.
Kami melaporkan bahwa browser tidak mendukung array yang diketik jika array tersebut tidak dapat disubklasifikasikan menggunakan proto . Firefox 4-29 tidak memiliki dukungan untuk menambahkan properti baru ke Uint8Array (Lihat: https://bugzilla.mozilla.org/show_bug.cgi?id=695438). IE 10 tidak memiliki dukungan untuk proto dan memiliki implementasi array yang diketik bermasalah.
Konstruktor Buffer mengembalikan instance Uint8Array yang prototipenya diubah menjadi Buffer.prototype . Selain itu, Buffer adalah subkelas dari Uint8Array , sehingga instance yang dikembalikan akan memiliki semua metode node Buffer dan metode Uint8Array . Notasi tanda kurung siku berfungsi seperti yang diharapkan -- ia mengembalikan satu oktet.
Prototipe Uint8Array tetap tidak dimodifikasi.
Secara fungsional setara dengan Buffer(arg, coding) tetapi memunculkan TypeError jika nilainya adalah angka. Buffer.dari(str[, pengkodean]) Buffer.dari(array) Buffer.dari(buffer) Buffer.dari(arrayBuffer[, byteOffset[, panjang]])
Secara fungsional setara dengan Buffer(arg, coding) tetapi memunculkan TypeError jika nilainya adalah angka. Buffer.dari(str[, pengkodean]) Buffer.dari(array) Buffer.dari(buffer) Buffer.dari(arrayBuffer[, byteOffset[, panjang]])
Secara fungsional setara dengan Buffer(arg, coding) tetapi memunculkan TypeError jika nilainya adalah angka. Buffer.dari(str[, pengkodean]) Buffer.dari(array) Buffer.dari(buffer) Buffer.dari(arrayBuffer[, byteOffset[, panjang]])
Secara fungsional setara dengan Buffer(arg, coding) tetapi memunculkan TypeError jika nilainya adalah angka. Buffer.dari(str[, pengkodean]) Buffer.dari(array) Buffer.dari(buffer) Buffer.dari(arrayBuffer[, byteOffset[, panjang]])
Membuat instance Buffer baru yang terisi. mengalokasikan(ukuran[, isi[, pengkodean]])
Membuat instance Buffer baru yang terisi. mengalokasikan(ukuran[, isi[, pengkodean]])
Membuat instance Buffer baru yang terisi. mengalokasikan(ukuran[, isi[, pengkodean]])
Membuat instance Buffer baru yang terisi. mengalokasikan(ukuran[, isi[, pengkodean]])
Setara dengan Buffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan Buffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan Buffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan Buffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan SlowBuffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan SlowBuffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan SlowBuffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Setara dengan SlowBuffer(num), secara default membuat instance Buffer yang tidak terisi nol.
Beberapa metode tingkat tinggi seputar crypto.subtle api untuk mendapatkan byte acak dan hashing.
API WebKripto
getRandomValues(buffer)Dokumen eksternal: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
Hasilkan nilai acak yang kuat secara kriptografis ke dalam buffer
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| penyangga | Array yang Diketik | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Array yang Diketik |
Ukuran total maksimum byte acak per halaman
Ukuran total maksimum untuk byte acak.
Jumlah total maksimum yang dialokasikan per halaman byte (maks/kuota)
randomBytes(size) Hasilkan size byte acak.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| ukuran | nomor | PALSU | Jumlah byte yang akan dihasilkan. Ukurannya tidak boleh lebih besar dari 2**31 - 1. |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Penyangga | Sebuah janji yang diselesaikan dengan instance socket.Buffer dengan byte acak. |
createDigest(algorithm, message)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| algoritma | rangkaian | PALSU | SHA-1 | |
| pesan | Penyangga | Array yang Diketik | Tampilan Data | PALSU | Sebuah contoh dari socket.Buffer, TypedArray atau Dataview. |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji | Sebuah janji yang diselesaikan dengan instance socket.Buffer dengan hash. |
Modul ini menyediakan implementasi soket datagram UDP. Itu tidak (belum) menyediakan metode atau properti multicast apa pun.
ERR_SOCKET_ALREADY_BOUND (meluas SocketError )Dilempar ketika soket sudah terikat.
ERR_SOCKET_DGRAM_IS_CONNECTED (memperluas SocketError )Dilempar ketika soket sudah tersambung.
ERR_SOCKET_DGRAM_NOT_CONNECTED (memperluas SocketError )Terlempar saat soket tidak tersambung.
ERR_SOCKET_DGRAM_NOT_RUNNING (meluas SocketError )Terlempar saat soket tidak berjalan (tidak terikat atau tersambung).
ERR_SOCKET_BAD_TYPE (meluas TypeError )Dilempar ketika tipe soket yang buruk digunakan dalam sebuah argumen.
ERR_SOCKET_BAD_PORT (memperluas RangeError )Dilempar ketika port yang buruk diberikan.
createSocket(options, callback) Membuat instance Socket . jika ()
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pilihan | tali | Obyek | PALSU | baik string ('udp4' atau 'udp6') atau objek opsi | |
| pilihan.tipe | rangkaian | BENAR | Keluarga soket. Harus berupa 'udp4' atau 'udp6'. Diperlukan. | |
| pilihan.reuseAddr | boolean | PALSU | BENAR | Ketika true socket.bind() akan menggunakan kembali alamat tersebut, meskipun proses lain telah mengikat soket di dalamnya. Bawaan: salah. |
| options.ipv6Only | boolean | PALSU | BENAR | Menyetel ipv6Only ke true akan menonaktifkan dukungan dual-stack, yaitu pengikatan ke alamat :: tidak akan membuat 0.0.0.0 terikat. Bawaan: salah. |
| pilihan.recvBufferSize | nomor | BENAR | Menetapkan nilai soket SO_RCVBUF. | |
| opsi.sendBufferSize | nomor | BENAR | Menetapkan nilai soket SO_SNDBUF. | |
| pilihan.sinyal | Batalkan Sinyal | BENAR | AbortSignal yang dapat digunakan untuk menutup soket. | |
| panggilan balik | fungsi | BENAR | Terlampir sebagai pendengar acara 'pesan'. Opsional. |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Stopkontak |
Socket (meluas EventEmitter )Contoh baru dgram.Socket dibuat menggunakan dgram.createSocket(). Kata kunci new tidak boleh digunakan untuk membuat instance dgram.Socket.
bind(port, address, callback)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketbindport-address-callback
Dengarkan pesan datagram pada port bernama dan alamat opsional. Jika alamat tidak ditentukan, sistem operasi akan mencoba mendengarkan semua alamat. Setelah pengikatan selesai, peristiwa 'mendengarkan' dikeluarkan dan fungsi panggilan balik opsional dipanggil.
Jika pengikatan gagal, peristiwa 'kesalahan' dikeluarkan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pelabuhan | nomor | PALSU | Port untuk mendengarkan pesan | |
| alamat | rangkaian | PALSU | Alamat yang akan diikat (0.0.0.0) | |
| panggilan balik | fungsi | PALSU | Tanpa parameter. Dipanggil saat pengikatan selesai. |
connect(port, host, connectListener)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketconnectport-address-callback
Mengaitkan dgram.Socket ke alamat dan port jarak jauh. Setiap pesan yang dikirim oleh pegangan ini secara otomatis dikirim ke tujuan tersebut. Selain itu, soket hanya akan menerima pesan dari rekan jarak jauh tersebut. Mencoba memanggil connect() pada soket yang sudah terhubung akan menghasilkan pengecualian ERR_SOCKET_DGRAM_IS_CONNECTED. Jika alamat tidak diberikan, '127.0.0.1' (untuk soket udp4) atau '::1' (untuk soket udp6) akan digunakan secara default. Setelah koneksi selesai, acara 'connect' dikeluarkan dan fungsi panggilan balik opsional dipanggil. Jika terjadi kegagalan, panggilan balik akan dipanggil atau, jika gagal, peristiwa 'kesalahan' akan dikeluarkan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pelabuhan | nomor | PALSU | Port tempat klien harus terhubung. | |
| tuan rumah | rangkaian | BENAR | Host tempat klien harus terhubung. | |
| connectListener | fungsi | BENAR | Parameter umum metode socket.connect(). Akan ditambahkan sebagai pendengar untuk acara 'connect' satu kali. |
disconnect()Dokumen eksternal: https://nodejs.org/api/dgram.html#socketdisconnect
Fungsi sinkron yang memisahkan dgram.Socket yang terhubung dari alamat jarak jauhnya. Mencoba memanggil putuskan() pada soket yang tidak terikat atau sudah terputus akan menghasilkan pengecualian ERR_SOCKET_DGRAM_NOT_CONNECTED.
send(msg, offset, length, port, address, callback)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback
Menyiarkan datagram pada soket. Untuk soket connectionless, port tujuan dan alamat harus ditentukan. Sebaliknya, soket yang terhubung akan menggunakan titik akhir jarak jauh yang terkait, sehingga argumen port dan alamat tidak boleh disetel.
Argumen pesan berisi pesan yang akan dikirim. Tergantung pada jenisnya, perilaku yang berbeda dapat diterapkan. Jika pesan adalah Buffer, TypedArray atau DataView apa pun, offset dan panjangnya menentukan offset dalam Buffer tempat pesan dimulai dan jumlah byte dalam pesan. Jika pesan adalah sebuah String, maka secara otomatis dikonversi ke Buffer dengan pengkodean 'utf8'. Dengan pesan yang berisi karakter multi-byte, offset dan panjangnya akan dihitung berdasarkan panjang byte dan bukan posisi karakter. Jika pesan adalah array, offset dan panjangnya tidak boleh ditentukan.
Argumen alamatnya adalah string. Jika nilai alamat adalah nama host, DNS akan digunakan untuk menentukan alamat host. Jika alamat tidak diberikan atau tidak ada, '127.0.0.1' (untuk soket udp4) atau '::1' (untuk soket udp6) akan digunakan secara default.
Jika soket belum pernah diikat sebelumnya dengan panggilan untuk mengikat, soket diberi nomor port acak dan diikat ke alamat "semua antarmuka" ('0.0.0.0' untuk soket udp4, '::0' untuk soket udp6 .)
Fungsi panggilan balik opsional dapat ditentukan sebagai cara melaporkan kesalahan DNS atau untuk menentukan kapan aman untuk menggunakan kembali objek buf. Pencarian DNS menunda waktu pengiriman setidaknya satu centang pada loop peristiwa Node.js.
Satu-satunya cara untuk mengetahui secara pasti bahwa datagram telah terkirim adalah dengan menggunakan callback. Jika terjadi kesalahan dan panggilan balik diberikan, kesalahan tersebut akan diteruskan sebagai argumen pertama ke panggilan balik tersebut. Jika panggilan balik tidak diberikan, kesalahan akan dikeluarkan sebagai peristiwa 'kesalahan' pada objek soket.
Offset dan panjang bersifat opsional, namun keduanya harus disetel jika salah satu digunakan. Mereka hanya didukung ketika argumen pertama adalah Buffer, TypedArray, atau DataView.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pesan | Penyangga | Array yang Diketik | Tampilan Data | tali | Himpunan | PALSU | Pesan yang akan dikirim. | |
| mengimbangi | bilangan bulat | BENAR | Offset di buffer tempat pesan dimulai. | |
| panjang | bilangan bulat | BENAR | Jumlah byte dalam pesan. | |
| pelabuhan | bilangan bulat | BENAR | Pelabuhan tujuan. | |
| alamat | rangkaian | BENAR | Nama host tujuan atau alamat IP. | |
| panggilan balik | Fungsi | BENAR | Dipanggil ketika pesan telah terkirim. |
close(callback)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketclosecallback
Tutup soket yang mendasarinya dan berhenti mendengarkan data di dalamnya. Jika panggilan balik disediakan, panggilan tersebut akan ditambahkan sebagai pendengar untuk acara 'tutup'.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| panggilan balik | fungsi | BENAR | Dipanggil ketika koneksi selesai atau terjadi kesalahan. |
address()Dokumen eksternal: https://nodejs.org/api/dgram.html#socketaddress
Mengembalikan objek yang berisi informasi alamat untuk soket. Untuk soket UDP, objek ini akan berisi properti alamat, keluarga, dan port.
Metode ini menampilkan EBADF jika dipanggil pada soket yang tidak terikat.
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| info soket | Obyek | Informasi tentang soket lokal |
| socketInfo.alamat | rangkaian | Alamat IP soket |
| socketInfo.port | rangkaian | Port soket |
| socketInfo.keluarga | rangkaian | Keluarga IP soket |
remoteAddress()Dokumen eksternal: https://nodejs.org/api/dgram.html#socketremoteaddress
Mengembalikan objek yang berisi alamat, keluarga, dan port titik akhir jarak jauh. Metode ini memunculkan pengecualian ERR_SOCKET_DGRAM_NOT_CONNECTED jika soket tidak terhubung.
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| info soket | Obyek | Informasi tentang soket jarak jauh |
| socketInfo.alamat | rangkaian | Alamat IP soket |
| socketInfo.port | rangkaian | Port soket |
| socketInfo.keluarga | rangkaian | Keluarga IP soket |
setRecvBufferSize(size)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize
Menyetel opsi soket SO_RCVBUF. Menetapkan buffer penerimaan soket maksimum dalam byte.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| ukuran | nomor | PALSU | Ukuran buffer penerimaan yang baru |
setSendBufferSize(size)Dokumen eksternal: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize
Menyetel opsi soket SO_SNDBUF. Menetapkan buffer pengiriman soket maksimum dalam byte.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| ukuran | nomor | PALSU | Ukuran buffer pengiriman baru |
getRecvBufferSize()Dokumen eksternal: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize
getSendBufferSize()Dokumen eksternal: https://nodejs.org/api/dgram.html#socketgetsendbuffersize
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | nomor | soket SO_SNDBUF mengirimkan ukuran buffer dalam byte. |
Modul ini memungkinkan resolusi nama. Misalnya, gunakan untuk mencari alamat IP nama host. Meskipun dinamai Domain Name System (DNS), ia tidak selalu menggunakan protokol DNS untuk pencarian. dns.lookup() menggunakan fasilitas sistem operasi untuk melakukan resolusi nama. Mungkin tidak perlu melakukan komunikasi jaringan apa pun. Untuk melakukan resolusi nama seperti yang dilakukan aplikasi lain pada sistem yang sama, gunakan dns.lookup().
lookup(hostname, opts, cb)Dokumen eksternal: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback
Menyelesaikan nama host (misalnya example.org ) ke dalam catatan A (IPv4) atau AAAA (IPv6) yang pertama kali ditemukan. Semua properti opsi bersifat opsional. Jika opsi adalah bilangan bulat, maka harus 4 atau 6 – jika opsi adalah 0 atau tidak tersedia, maka alamat IPv4 dan IPv6 akan dikembalikan jika ditemukan.
Dari situs web node.js...
Dengan opsi semua disetel ke true, argumen untuk panggilan balik berubah menjadi (err, alamat), dengan alamat berupa larik objek dengan properti alamat dan keluarga.
Saat error, err adalah objek Error, dimana err.code adalah kode errornya. Ingatlah bahwa err.code akan disetel ke 'ENOTFOUND' tidak hanya ketika nama host tidak ada tetapi juga ketika pencarian gagal karena alasan lain seperti tidak ada deskriptor file yang tersedia. dns.lookup() tidak selalu ada hubungannya dengan protokol DNS. Implementasinya menggunakan fasilitas sistem operasi yang dapat mengasosiasikan nama dengan alamat dan sebaliknya. Implementasi ini dapat menimbulkan konsekuensi halus namun penting pada perilaku program Node.js mana pun. Harap luangkan waktu untuk membaca bagian Pertimbangan penerapan sebelum menggunakan dns.lookup().
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| nama host | rangkaian | PALSU | Nama host yang akan diselesaikan. | |
| memilih | Obyek | BENAR | Sebuah objek pilihan. | |
| opts.family | nomor | rangkaian | 0 | PALSU | Keluarga rekaman. Harus 4, 6, atau 0. Untuk alasan kompatibilitas mundur, 'IPv4' dan 'IPv6' masing-masing ditafsirkan sebagai 4 dan 6. Nilai 0 menunjukkan bahwa alamat IPv4 dan IPv6 keduanya dikembalikan. Bawaan: 0. |
| cb | fungsi | PALSU | Fungsi yang dipanggil setelah metode selesai. |
Modul ini memungkinkan resolusi nama. Misalnya, gunakan untuk mencari alamat IP nama host. Meskipun dinamai Domain Name System (DNS), ia tidak selalu menggunakan protokol DNS untuk pencarian. dns.lookup() menggunakan fasilitas sistem operasi untuk melakukan resolusi nama. Mungkin tidak perlu melakukan komunikasi jaringan apa pun. Untuk melakukan resolusi nama seperti yang dilakukan aplikasi lain pada sistem yang sama, gunakan dns.lookup().
lookup(hostname, opts)Dokumen eksternal: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| nama host | rangkaian | PALSU | Nama host yang akan diselesaikan. | |
| memilih | Obyek | BENAR | Sebuah objek pilihan. | |
| opts.family | nomor | rangkaian | 0 | PALSU | Keluarga rekaman. Harus 4, 6, atau 0. Untuk alasan kompatibilitas mundur, 'IPv4' dan 'IPv6' masing-masing ditafsirkan sebagai 4 dan 6. Nilai 0 menunjukkan bahwa alamat IPv4 dan IPv6 keduanya dikembalikan. Bawaan: 0. |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
Modul ini memungkinkan interaksi dengan sistem file dengan cara yang meniru fungsi POSIX standar.
Application Sandbox membatasi akses ke sistem file. Silakan lihat dokumentasi Application Sandbox untuk informasi lebih lanjut: https://sockets.sh/guides/#working-with-the-file-system-on-ios
Untuk menggunakan API berbasis janji:
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;Untuk menggunakan API callback dan async:
import * as fs from '@socketsupply/socket-api/fs/index.js' ; access(path, mode , callback)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback
Periksa akses file secara asinkron untuk mode tertentu yang memanggil callback setelah berhasil atau terjadi kesalahan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| mode | rangkaian | F_OK(0) | BENAR | |
| panggilan balik | fungsi (err, fd) | PALSU |
chmod(path, mode, callback)Dokumen eksternal: https://nodejs.org/api/fs.html#fschmodpath-mode-callback
Mengubah izin file secara asinkron. Tidak ada argumen selain kemungkinan pengecualian yang diberikan pada panggilan balik penyelesaian
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| mode | nomor | PALSU | ||
| panggilan balik | fungsi (salah) | PALSU |
close(fd, callback) Tutup deskriptor file yang memanggil callback secara asinkron jika berhasil atau terjadi kesalahan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| fd | nomor | PALSU | ||
| panggilan balik | fungsi (salah) | BENAR |
copyFile() Ini adalah FunctionDeclaration bernama copyFile di fs/index.js , diekspor tetapi tidak berdokumen.
createReadStream(path, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | fs.ReadStream |
createWriteStream(path, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | fs.WriteStream |
fstat(fd, options, callback)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback
Memanggil callback dengan <fs.Stats> untuk deskriptor file. Lihat dokumentasi POSIX fstat(2) untuk detail lebih lanjut.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| fd | nomor | PALSU | Deskriptor file. | |
| pilihan | Obyek | BENAR | Sebuah objek pilihan. | |
| panggilan balik | fungsi | PALSU | Fungsi untuk dipanggil setelah selesai. |
open(path, flags , mode , callback) Buka file yang memanggil callback secara asinkron setelah berhasil atau terjadi kesalahan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| bendera | rangkaian | R | BENAR | |
| mode | rangkaian | 0o666 | BENAR | |
| panggilan balik | fungsi (err, fd) | PALSU |
opendir(path, options, callback) Buka direktori yang memanggil callback secara asinkron setelah berhasil atau terjadi kesalahan.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | Obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.denganFileTypes | boolean | PALSU | BENAR | |
| panggilan balik | fungsi (err, fd) | PALSU |
read(fd, buffer, offset, length, position, callback)Membaca secara asinkron dari deskriptor file yang terbuka.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| fd | nomor | PALSU | ||
| penyangga | objek | Penyangga | Array yang Diketik | PALSU | Buffer tempat data akan ditulis. | |
| mengimbangi | nomor | PALSU | Posisi di buffer untuk menulis data. | |
| panjang | nomor | PALSU | Jumlah byte yang akan dibaca. | |
| posisi | nomor | BigInt | batal | PALSU | Menentukan dari mana untuk mulai membaca dalam file. Jika position adalah null atau -1 , data akan dibaca dari posisi file saat ini, dan posisi file akan diperbarui. Jika posisi adalah bilangan bulat, posisi file tidak akan berubah. | |
| panggilan balik | fungsi(err, byteBaca, buffer) | PALSU |
readdir(path, options, callback)Membaca semua entri dalam direktori secara asinkron.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.denganFileTypes | boolean | PALSU | BENAR | |
| panggilan balik | fungsi (err, buffer) | PALSU |
readFile(path, options, callback)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | nomor | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.bendera | rangkaian | R | BENAR | |
| pilihan.sinyal | Batalkan Sinyal | BENAR | ||
| panggilan balik | fungsi (err, buffer) | PALSU |
stat(path, options, callback)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | nomor | PALSU | nama file atau deskriptor file | |
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.bendera | rangkaian | R | BENAR | |
| pilihan.sinyal | Batalkan Sinyal | BENAR | ||
| panggilan balik | fungsi (err, data) | PALSU |
writeFile(path, data, options, callback)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | nomor | PALSU | nama file atau deskriptor file | |
| data | tali | Penyangga | Array yang Diketik | Tampilan Data | obyek | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.mode | rangkaian | 0o666 | BENAR | |
| pilihan.bendera | rangkaian | w | BENAR | |
| pilihan.sinyal | Batalkan Sinyal | BENAR | ||
| panggilan balik | fungsi (salah) | PALSU |
writev() Ini adalah FunctionDeclaration bernama writev di fs/index.js , diekspor tetapi tidak berdokumen.
access(path, mode, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode
Periksa akses file secara asinkron.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| mode | rangkaian | BENAR | ||
| pilihan | obyek | BENAR |
chmod(path, mode)Dokumen eksternal: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| mode | nomor | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
mkdir(path, options)Membuat direktori secara asinkron.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | Rangkaian | PALSU | Jalan untuk menciptakan | |
| pilihan | Obyek | PALSU | Argumen opsi opsional dapat berupa mode penentu bilangan bulat (izin dan bit lengket), atau objek dengan properti mode dan properti rekursif yang menunjukkan apakah direktori induk harus dibuat. Memanggil fs.mkdir() ketika jalur adalah direktori yang ada hanya menghasilkan kesalahan jika rekursifnya salah. |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Hadiah utama | Setelah berhasil, penuhi dengan tidak terdefinisi jika rekursif salah, atau jalur direktori pertama dibuat jika rekursif benar. |
open(path, flags, mode)Dokumen eksternal: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
Membuka file secara asinkron.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| bendera | rangkaian | PALSU | bawaan: 'r' | |
| mode | rangkaian | PALSU | bawaan: 0o666 |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
opendir(path, options)Dokumen eksternal: https://nodejs.org/api/fs.html#fspromisesopendirpath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.bufferSize | nomor | 32 | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<FileSystem,Dir> |
readdir(path, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | rangkaian | utf8 | BENAR | |
| pilihan.denganFileTypes | boolean | PALSU | BENAR |
readFile(path, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | rangkaian | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | tali | batal | batal | BENAR | |
| pilihan.bendera | rangkaian | R | BENAR | |
| pilihan.sinyal | Batalkan Sinyal | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<Penyangga | tali> |
stat(path, options)Dokumen eksternal: https://nodejs.org/api/fs.html#fspromisesstatpath-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.bigint | boolean | PALSU | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
writeFile(path, data, options)Dokumen eksternal: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| jalur | tali | Penyangga | URL | FileHandle | PALSU | nama file atau FileHandle | |
| data | tali | Penyangga | Himpunan | Tampilan Data | Array yang Diketik | Sungai kecil | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.encoding | tali | batal | utf8 | PALSU | |
| pilihan.mode | nomor | 0o666 | PALSU | |
| pilihan.bendera | rangkaian | w | PALSU | |
| pilihan.sinyal | Batalkan Sinyal | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
Ini adalah VariableDeclaration bernama DEFAULT_STREAM_HIGH_WATER_MARK di fs/stream.js , diekspor tetapi tidak berdokumen.
ReadStream (memperluas Readable ) Aliran Readable untuk FileHandle .
constructor() Konstruktor kelas ReadStream
setHandle(handle)Menetapkan pegangan file untuk ReadStream.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| menangani | FileHandle | PALSU |
highWaterMark()Ukuran buffer maksimal untuk ReadStream.
path() Jalur relatif atau absolut dari FileHandle yang mendasarinya.
pending() true jika streaming berada dalam status tertunda.
emit() Menangani pengaturan shouldEmitClose dari options.emitClose di konstruktor.
WriteStream (memperluas Writable ) Aliran Writable untuk FileHandle .
constructor() Konstruktor kelas WriteStream
setHandle(handle)Menetapkan pegangan file untuk WriteStream.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| menangani | FileHandle | PALSU |
highWaterMark()Ukuran buffer maksimal untuk Writetream.
path() Jalur relatif atau absolut dari FileHandle yang mendasarinya.
pending() true jika streaming berada dalam status tertunda.
emit() Menangani pengaturan shouldEmitClose dari options.emitClose di konstruktor.
Ini adalah VariableDeclaration bernama FileReadStream di fs/stream.js , diekspor tetapi tidak berdokumen.
Ini adalah VariableDeclaration bernama FileWriteStream di fs/stream.js , diekspor tetapi tidak berdokumen.
Ini adalah API tingkat rendah yang tidak Anda perlukan kecuali Anda mengimplementasikan perpustakaan di atas Socket SDK. Aplikasi Socket SDK memiliki dua atau tiga proses.
Render , UI tempat HTML, CSS dan JS dijalankan.Bridge , lapisan tipis kode yang mengatur segalanya.Main , untuk aplikasi yang perlu menjalankan pekerjaan komputasi yang lebih berat. Dan tidak seperti elektron, ini opsional.Proses Bridge mengelola proses Render dan Main, dan juga dapat menjadi perantara data di antara keduanya.
Proses Binding menggunakan input dan output standar sebagai cara untuk berkomunikasi. Data yang ditulis ke ujung tulis pipa disangga oleh OS hingga dibaca dari ujung baca pipa.
Protokol IPC menggunakan skema sederhana seperti URI. Data diteruskan sebagai ArrayBuffers.
ipc://command?key1=value1&key2=value2...
postMessage() Ini adalah FunctionDeclaration bernama postMessage di ipc.js , diekspor tetapi tidak berdokumen.
Mewakili status IPC OK.
Mewakili status ERROR IPC.
Batas waktu dalam milidetik untuk permintaan IPC.
Simbol untuk properti ipc.debug.enabled
parseSeq(seq, options) Parsing seq sebagai nilai integer
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| seq | tali | nomor | PALSU | ||
| pilihan | obyek | BENAR | ||
| options.bigint | boolean | PALSU | PALSU |
debug(enable) Jika debug.enabled === true , maka keluaran debug akan dicetak ke konsol.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memungkinkan | boolean | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | boolean |
Message (memperluas URL ) Kontainer untuk pesan IPC berdasarkan skema ipc:// URI.
PROTOCOL()Protokol yang diharapkan untuk pesan IPC.
from(input, params) Membuat instance Message dari berbagai input.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| masukan | tali | URL | Pesan | Penyangga | obyek | PALSU | ||
| param | objek | tali | URLSearchParams | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Pesan |
isValidInput(input) Predikat untuk menentukan apakah input valid untuk membuat instance Message baru.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| masukan | tali | URL | Pesan | Penyangga | obyek | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | boolean |
constructor(input) Konstruktor kelas Message .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| masukan | tali | URL | PALSU |
command()Nama pesan IPC yang dihitung.
name()Nama pesan IPC yang dihitung.
id() Nilai id yang dihitung untuk perintah.
seq() Nilai seq (urutan) yang dihitung untuk perintah.
value()Nilai pesan yang dihitung berpotensi diberikan dalam parameter pesan. Nilai ini secara otomatis didekodekan, namun tidak diperlakukan sebagai JSON.
index() Nilai index yang dihitung untuk perintah yang berpotensi merujuk pada indeks jendela tempat atau asal perintah tersebut. Jika tidak ditentukan dalam parameter pesan, maka nilai defaultnya adalah -1 .
json() Nilai yang dihitung diurai sebagai JSON. Nilai ini null jika nilainya tidak ada atau JSON tidak valid.
params()Objek readonly yang dihitung dari parameter pesan.
entries()Mengembalikan parameter yang dihitung sebagai entri
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Larik<Array<string,campuran>> |
set(key, value) Tetapkan value parameter berdasarkan key .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| kunci | rangkaian | PALSU | ||
| nilai | campur aduk | PALSU |
get(key, defaultValue) Dapatkan nilai parameter dengan key .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| kunci | rangkaian | PALSU | ||
| Nilai default | campur aduk | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | campur aduk |
delete(key) Hapus parameter berdasarkan key .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| kunci | rangkaian | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | boolean |
keys()Kunci parameter yang dihitung.
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Himpunan |
values()Nilai parameter yang dihitung.
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Himpunan |
has(key) Predikat untuk menentukan apakah key parameter ada dalam parameter.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| kunci | rangkaian | PALSU |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | boolean |
toJSON() Mengonversi instance Message menjadi objek JSON biasa.
Tipe hasil yang digunakan secara internal untuk menangani nilai hasil IPC dari lapisan asli dalam bentuk { err?, data? } . Properti data dan err pada objek jenis ini berbentuk tuple dan dapat diakses di [data?,err?]
from(result, maybeError, maybeSource) Membuat instance Result dari input yang mungkin berupa objek seperti { err?, data? } , contoh Error , atau hanya data .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| hasil | objek | Kesalahan | campur aduk | BENAR | ||
| mungkinKesalahan | Kesalahan | BENAR | ||
| mungkinSumber | rangkaian | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Hasil |
constructor(err , data , source ) Konstruktor kelas Result .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| berbuat salah | Kesalahan | batal | BENAR | |
| data | obyek | batal | BENAR | |
| sumber | rangkaian | belum diartikan | BENAR |
length()Panjang hasil yang dihitung.
ready()Menunggu lapisan IPC asli siap dan diekspos pada objek jendela global.
sendSync(command, params) Mengirimkan perintah IPC sinkron melalui XHR yang mengembalikan Result setelah berhasil atau salah.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memerintah | rangkaian | PALSU | ||
| param | objek | rangkaian | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Hasil |
emit(name, value, target , options) Keluarkan acara untuk dikirim pada objek window .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| nama | rangkaian | PALSU | ||
| nilai | Campur aduk | PALSU | ||
| target | Target Acara | jendela | BENAR | |
| pilihan | Obyek | BENAR |
resolve(seq, value) Menyelesaikan permintaan berdasarkan seq dengan nilai yang mungkin.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| seq | rangkaian | PALSU | ||
| nilai | Campur aduk | PALSU |
send(command, value)Mengirimkan permintaan perintah IPC async dengan parameter.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memerintah | rangkaian | PALSU | ||
| nilai | Campur aduk | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
write(command, params, buffer, options)Mengirimkan permintaan perintah IPC async dengan parameter dan byte buffer.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memerintah | rangkaian | PALSU | ||
| param | obyek | BENAR | ||
| penyangga | Penyangga | TipeArray | ArrayBuffer | tali | Himpunan | BENAR | ||
| pilihan | obyek | BENAR |
request(command, params, options)Mengirimkan permintaan perintah IPC async dengan parameter yang meminta respons dengan byte buffer.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memerintah | rangkaian | PALSU | ||
| param | obyek | BENAR | ||
| pilihan | obyek | BENAR |
createBinding(domain, ctx)Pabrik untuk membuat API IPC berbasis proxy.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| domain | rangkaian | PALSU | ||
| ctx | fungsi | obyek | BENAR | ||
| ctx.default | rangkaian | BENAR |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Proksi |
Modul ini menyediakan informasi sistem yang dinormalisasi dari semua sistem operasi utama.
arch() Ini adalah FunctionDeclaration bernama arch di os.js , diekspor tetapi tidak berdokumen.
networkInterfaces() Ini adalah FunctionDeclaration bernama networkInterfaces di os.js , diekspor tetapi tidak berdokumen.
platform() Ini adalah platform bernama FunctionDeclaration di os.js , diekspor tetapi tidak berdokumen.
type() Ini adalah type bernama FunctionDeclaration di os.js , diekspor tetapi tidak berdokumen.
isWindows() Ini adalah FunctionDeclaration bernama isWindows di os.js , diekspor tetapi tidak berdokumen.
tmpdir() Ini adalah FunctionDeclaration bernama tmpdir di os.js , diekspor tetapi tidak berdokumen.
Ini adalah VariableDeclaration bernama EOL di os.js , diekspor tetapi tidak berdokumen.
Ini adalah ClassDeclaration bernama Path di path/path.js , diekspor tetapi tidak berdokumen.
cwd(opts)Menghitung direktori kerja saat ini untuk suatu jalur
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memilih | obyek | BENAR | ||
opts.posix Setel ke true untuk memaksa jalur gaya POSIX | boolean | BENAR |
constructor(opts) Konstruktor kelas Path .
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memilih | obyek | BENAR | ||
| opts.root | rangkaian | BENAR | ||
| opts.base | rangkaian | BENAR | ||
| opts.nama | rangkaian | BENAR | ||
| opts.dir | rangkaian | BENAR | ||
| opts.ext | rangkaian | BENAR |
resolve()normalize()homedir()| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | rangkaian | Direktori home pengguna saat ini. |
exit(code)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| kode | nomor | 0 | BENAR | Kode keluar. Bawaan: 0. |
Menyediakan metode khusus runtime
Ini adalah VariableDeclaration bernama currentWindow di runtime.js , diekspor tetapi tidak berdokumen.
Ini adalah VariableDeclaration bernama debug di runtime.js , diekspor tetapi tidak berdokumen.
Ini adalah VariableDeclaration bernama config di runtime.js , diekspor tetapi tidak berdokumen.
send() Ini adalah FunctionDeclaration bernama send in runtime.js , diekspor tetapi tidak berdokumen.
getWindows() Ini adalah FunctionDeclaration bernama getWindows di runtime.js , diekspor tetapi tidak berdokumen.
openExternal() Ini adalah FunctionDeclaration bernama openExternal di runtime.js , diekspor tetapi tidak berdokumen.
exit(options)Keluar dari proses backend lalu keluar dari proses render, kode keluar yang digunakan adalah kode keluar terakhir ke OS.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pilihan | obyek | PALSU | sebuah objek pilihan |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
setTitle(options)Menetapkan judul jendela (jika ada).
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pilihan | obyek | PALSU | sebuah objek pilihan |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
inspect() Ini adalah FunctionDeclaration bernama inspect di runtime.js , diekspor tetapi tidak berdokumen.
show(opts)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memilih | obyek | PALSU | sebuah objek pilihan |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
hide(opts)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memilih | obyek | PALSU | sebuah objek pilihan |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
navigate(opts)| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| memilih | obyek | PALSU | sebuah objek pilihan | |
| opts.window | nomor | Jendela saat ini | PALSU | indeks jendela |
| opts.url | nomor | PALSU | jalur ke file HTML untuk dimuat ke jendela |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji<ipc.Hasil> |
setWindowBackgroundColor() Ini adalah FunctionDeclaration bernama setWindowBackgroundColor di runtime.js , diekspor tetapi tidak berdokumen.
setContextMenu(options)Membuka menu konteks asli.
| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pilihan | obyek | PALSU | sebuah objek pilihan |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
setSystemMenuItemEnabled() Ini adalah FunctionDeclaration bernama setSystemMenuItemEnabled di runtime.js , diekspor tetapi tidak berdokumen.
setSystemMenu(options)Atur menu asli untuk aplikasi.
Socket Runtime menyediakan DSL minimalis yang memudahkan pembuatan sistem asli lintas platform dan menu konteks.
Menu dibuat pada saat run time. Mereka dapat dibuat dari proses Utama atau Render. Mereka dapat dibuat ulang secara instan dengan memanggil metode setSystemMenu .
Metode ini mengambil sebuah string. Berikut ini contoh menunya. Titik koma penting menunjukkan akhir menu. Gunakan garis bawah jika tidak ada tombol akselerator. Pengubah bersifat opsional. Dan opsi menu OS terkenal seperti menu edit akan secara otomatis mendapatkan akselerator yang tidak perlu Anda tentukan.
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;
` ) Untuk membuat pemisah, gunakan tiga tanda hubung --- .
Pengubah akselerator digunakan sebagai indikator visual namun tidak memiliki dampak material karena pengikatan kunci sebenarnya dilakukan di pendengar acara.
Huruf kapital menyiratkan bahwa akselerator diubah dengan tombol Shift .
Akselerator tambahan adalah Meta , Control , Option , masing-masing dipisahkan dengan koma. Jika salah satu tidak berlaku untuk suatu platform, maka akan diabaikan begitu saja.
Di MacOS Meta sama dengan Command .
Jika Anda ingin menonaktifkan item menu cukup awali item tersebut dengan ! karakter. Ini akan menyebabkan item tersebut tampak dinonaktifkan saat menu sistem ditampilkan.
Kami merasa menu bersarang adalah anti-pola. Kami tidak menggunakannya. Jika Anda memiliki argumen yang kuat untuk hal tersebut dan permintaan penarikan yang sangat sederhana yang membuatnya berfungsi, kami dapat mempertimbangkannya.
Saat item menu diaktifkan, ini memunculkan acara menuItemSelected di kode ujung depan, Anda kemudian dapat berkomunikasi dengan kode backend Anda jika Anda mau dari sana.
Misalnya, jika item Apple dipilih dari menu Other ...
window . addEventListener ( 'menuItemSelected' , event => {
assert ( event . detail . parent === 'Other' )
assert ( event . detail . title === 'Apple' )
} )| Argumen | Jenis | Bawaan | Opsional | Keterangan |
|---|---|---|---|---|
| pilihan | obyek | PALSU | sebuah objek pilihan | |
| pilihan.nilai | rangkaian | PALSU | tata letak menunya | |
| pilihan.index | nomor | PALSU | jendela yang akan ditargetkan (jika ada) |
| Nilai Pengembalian | Jenis | Keterangan |
|---|---|---|
| Tidak ditentukan | Janji |
reload() Ini adalah FunctionDeclaration bernama reload di runtime.js , diekspor tetapi tidak berdokumen.
