socket api

บลูทูธ

API ข้ามแพลตฟอร์มระดับสูงสำหรับ Bluetooth Pub-Sub

Bluetooth (ขยาย EventEmitter )

สร้างอินสแตนซ์ของบริการ Bluetooth

constructor(serviceId)

Constructor เป็นคุณสมบัติตัวอย่างที่ตั้งค่าเป็น true สร้างบริการใหม่ด้วยคู่คีย์-ค่า

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รหัสบริการ	เชือก		เท็จ	กำหนดค่าเริ่มต้นเพื่อกำหนดประเภท

start()

เริ่มบริการบลูทูธ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

subscribe(id )

เริ่มการสแกนหาค่าที่เผยแพร่ซึ่งสอดคล้องกับ UUID ที่รู้จักกันดี เมื่อสมัครสมาชิก UUID แล้ว กิจกรรมที่สอดคล้องกับ UUID นั้นจะถูกปล่อยออกมา หากต้องการรับกิจกรรมเหล่านี้ คุณสามารถเพิ่มผู้ฟังเหตุการณ์ได้ เช่น...

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

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รหัส	เชือก		เท็จ	UUID ที่รู้จักกันดี

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

publish(id, value)

เริ่มโฆษณาคุณค่าใหม่สำหรับ UUID ที่รู้จักกันดี

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รหัส	เชือก		เท็จ	UUID ที่รู้จักกันดี
ค่า	เชือก		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

บัฟเฟอร์

เอกสารภายนอก: https://nodejs.org/api/buffer.html#buffer_class_buffer

โมดูลบัฟเฟอร์จาก node.js สำหรับเบราว์เซอร์

บัฟเฟอร์

หาก Buffer.TYPED_ARRAY_SUPPORT : === true ใช้การใช้งาน Uint8Array (เร็วที่สุด) === false คำเตือนการพิมพ์และแนะนำให้ใช้ buffer v4.x ซึ่งมีการใช้งาน Object (เข้ากันได้มากที่สุด แม้กระทั่ง IE6)

เบราว์เซอร์ที่รองรับอาร์เรย์ที่พิมพ์ ได้แก่ IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+

เรารายงานว่าเบราว์เซอร์ไม่รองรับอาร์เรย์ที่พิมพ์ หากไม่สามารถคลาสย่อยได้โดยใช้ proto Firefox 4-29 ขาดการสนับสนุนสำหรับการเพิ่มคุณสมบัติใหม่ให้กับ Uint8Array (ดู: https://bugzilla.mozilla.org/show_bug.cgi?id=695438) IE 10 ขาดการสนับสนุนสำหรับ โปรโต และมีการใช้งานอาร์เรย์ที่พิมพ์แบบบั๊กกี้

ไม่ได้กำหนด

หาก Buffer.TYPED_ARRAY_SUPPORT : === true ใช้การใช้งาน Uint8Array (เร็วที่สุด) === false คำเตือนการพิมพ์และแนะนำให้ใช้ buffer v4.x ซึ่งมีการใช้งาน Object (เข้ากันได้มากที่สุด แม้กระทั่ง IE6)

เบราว์เซอร์ที่รองรับอาร์เรย์ที่พิมพ์ ได้แก่ IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+

เรารายงานว่าเบราว์เซอร์ไม่รองรับอาร์เรย์ที่พิมพ์ หากไม่สามารถคลาสย่อยได้โดยใช้ proto Firefox 4-29 ขาดการสนับสนุนสำหรับการเพิ่มคุณสมบัติใหม่ให้กับ Uint8Array (ดู: https://bugzilla.mozilla.org/show_bug.cgi?id=695438) IE 10 ขาดการสนับสนุนสำหรับ โปรโต และมีการใช้งานอาร์เรย์ที่พิมพ์แบบบั๊กกี้

ไม่ได้กำหนด

หาก Buffer.TYPED_ARRAY_SUPPORT : === true ใช้การใช้งาน Uint8Array (เร็วที่สุด) === false คำเตือนการพิมพ์และแนะนำให้ใช้ buffer v4.x ซึ่งมีการใช้งาน Object (เข้ากันได้มากที่สุด แม้กระทั่ง IE6)

เบราว์เซอร์ที่รองรับอาร์เรย์ที่พิมพ์ ได้แก่ IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+

เรารายงานว่าเบราว์เซอร์ไม่รองรับอาร์เรย์ที่พิมพ์ หากไม่สามารถคลาสย่อยได้โดยใช้ proto Firefox 4-29 ขาดการสนับสนุนสำหรับการเพิ่มคุณสมบัติใหม่ให้กับ Uint8Array (ดู: https://bugzilla.mozilla.org/show_bug.cgi?id=695438) IE 10 ขาดการสนับสนุนสำหรับ โปรโต และมีการใช้งานอาร์เรย์ที่พิมพ์แบบบั๊กกี้

ไม่ได้กำหนด

หาก Buffer.TYPED_ARRAY_SUPPORT : === true ใช้การใช้งาน Uint8Array (เร็วที่สุด) === false คำเตือนการพิมพ์และแนะนำให้ใช้ buffer v4.x ซึ่งมีการใช้งาน Object (เข้ากันได้มากที่สุด แม้กระทั่ง IE6)

เบราว์เซอร์ที่รองรับอาร์เรย์ที่พิมพ์ ได้แก่ IE 10+, Firefox 4+, Chrome 7+, Safari 5.1+, Opera 11.6+, iOS 4.2+

เรารายงานว่าเบราว์เซอร์ไม่รองรับอาร์เรย์ที่พิมพ์ หากไม่สามารถคลาสย่อยได้โดยใช้ proto Firefox 4-29 ขาดการสนับสนุนสำหรับการเพิ่มคุณสมบัติใหม่ให้กับ Uint8Array (ดู: https://bugzilla.mozilla.org/show_bug.cgi?id=695438) IE 10 ขาดการสนับสนุนสำหรับ โปรโต และมีการใช้งานอาร์เรย์ที่พิมพ์แบบบั๊กกี้

ไม่ได้กำหนด

ตัวสร้างบัฟเฟอร์ส่งคืนอินสแตนซ์ของ Uint8Array ที่เปลี่ยนต้นแบบเป็น Buffer.prototype นอกจากนี้ Buffer ยังเป็นคลาสย่อยของ Uint8Array ดังนั้นอินสแตนซ์ที่ส่งคืนจะมีวิธี Node Buffer และวิธี Uint8Array ทั้งหมด สัญลักษณ์วงเล็บเหลี่ยมทำงานได้ตามที่คาดไว้ โดยจะส่งค่าออคเต็ตเดียว

ต้นแบบ Uint8Array ยังคงไม่มีการแก้ไข

บัฟเฟอร์

ใช้งานได้เทียบเท่ากับบัฟเฟอร์ (arg, การเข้ารหัส) แต่จะส่ง TypeError หากค่าเป็นตัวเลข Buffer.from(str[, การเข้ารหัส]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])

ไม่ได้กำหนด

ใช้งานได้เทียบเท่ากับบัฟเฟอร์ (arg, การเข้ารหัส) แต่จะส่ง TypeError หากค่าเป็นตัวเลข Buffer.from(str[, การเข้ารหัส]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])

ไม่ได้กำหนด

ใช้งานได้เทียบเท่ากับบัฟเฟอร์ (arg, การเข้ารหัส) แต่จะส่ง TypeError หากค่าเป็นตัวเลข Buffer.from(str[, การเข้ารหัส]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])

ไม่ได้กำหนด

ใช้งานได้เทียบเท่ากับบัฟเฟอร์ (arg, การเข้ารหัส) แต่จะส่ง TypeError หากค่าเป็นตัวเลข Buffer.from(str[, การเข้ารหัส]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])

บัฟเฟอร์

สร้างอินสแตนซ์บัฟเฟอร์ที่เติมใหม่ จัดสรร (ขนาด [, เติม [, การเข้ารหัส]])

ไม่ได้กำหนด

สร้างอินสแตนซ์บัฟเฟอร์ที่เติมใหม่ จัดสรร (ขนาด [, เติม [, การเข้ารหัส]])

ไม่ได้กำหนด

สร้างอินสแตนซ์บัฟเฟอร์ที่เติมใหม่ จัดสรร (ขนาด [, เติม [, การเข้ารหัส]])

ไม่ได้กำหนด

สร้างอินสแตนซ์บัฟเฟอร์ที่เติมใหม่ จัดสรร (ขนาด [, เติม [, การเข้ารหัส]])

บัฟเฟอร์

เทียบเท่ากับ Buffer(num) โดยค่าเริ่มต้นจะสร้างอินสแตนซ์ Buffer ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ Buffer(num) โดยค่าเริ่มต้นจะสร้างอินสแตนซ์ Buffer ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ Buffer(num) โดยค่าเริ่มต้นจะสร้างอินสแตนซ์ Buffer ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ Buffer(num) โดยค่าเริ่มต้นจะสร้างอินสแตนซ์ Buffer ที่ไม่เติมศูนย์

บัฟเฟอร์

เทียบเท่ากับ SlowBuffer(num) ตามค่าเริ่มต้นจะสร้างอินสแตนซ์บัฟเฟอร์ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ SlowBuffer(num) ตามค่าเริ่มต้นจะสร้างอินสแตนซ์บัฟเฟอร์ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ SlowBuffer(num) ตามค่าเริ่มต้นจะสร้างอินสแตนซ์บัฟเฟอร์ที่ไม่เติมศูนย์

ไม่ได้กำหนด

เทียบเท่ากับ SlowBuffer(num) ตามค่าเริ่มต้นจะสร้างอินสแตนซ์บัฟเฟอร์ที่ไม่เติมศูนย์

การเข้ารหัสลับ

วิธีการระดับสูงบางอย่างรอบ ๆ crypto.subtle api เพื่อรับไบต์และการแฮชแบบสุ่ม

เว็บคริปโต

เว็บคริปโต API

getRandomValues(buffer)

เอกสารภายนอก: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues

สร้างค่าสุ่มที่แข็งแกร่งในการเข้ารหัสลงใน buffer

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
บัฟเฟอร์	TypedArray		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	TypedArray

RANDOM_BYTES_QUOTA

ขนาดรวมสูงสุดของไบต์สุ่มต่อหน้า

MAX_RANDOM_BYTES

ขนาดรวมสูงสุดสำหรับไบต์แบบสุ่ม

MAX_RANDOM_BYTES_PAGES

จำนวนรวมสูงสุดที่จัดสรรต่อหน้าไบต์ (สูงสุด/โควต้า)

randomBytes(size)

สร้างไบต์สุ่ม size

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ขนาด	ตัวเลข		เท็จ	จำนวนไบต์ที่จะสร้าง ขนาดต้องไม่ใหญ่กว่า 2**31 - 1

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	บัฟเฟอร์	คำสัญญาที่แก้ไขได้ด้วยอินสแตนซ์ของซ็อกเก็ต บัฟเฟอร์ด้วยไบต์แบบสุ่ม

createDigest(algorithm, message)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
อัลกอริทึม	เชือก		เท็จ	SHA-1
ข้อความ	บัฟเฟอร์ | TypedArray | DataView		เท็จ	อินสแตนซ์ของ socket.Buffer, TypedArray หรือ Dataview

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา	คำสัญญาที่แก้ไขได้ด้วยอินสแตนซ์ของซ็อกเก็ต บัฟเฟอร์พร้อมแฮช

ดีแกรม

โมดูลนี้จัดเตรียมการใช้งานซ็อกเก็ตดาตาแกรม UDP ยังไม่มีวิธีหรือคุณสมบัติมัลติคาสต์ใดๆ

ERR_SOCKET_ALREADY_BOUND (ขยาย SocketError )

โยนเมื่อซ็อกเก็ตถูกผูกไว้แล้ว

ERR_SOCKET_DGRAM_IS_CONNECTED (ขยาย SocketError )

โยนออกเมื่อเชื่อมต่อซ็อกเก็ตแล้ว

ERR_SOCKET_DGRAM_NOT_CONNECTED (ขยาย SocketError )

โยนเมื่อไม่ได้เชื่อมต่อซ็อกเก็ต

ERR_SOCKET_DGRAM_NOT_RUNNING (ขยาย SocketError )

โยนเมื่อซ็อกเก็ตไม่ทำงาน (ไม่ได้ผูกหรือเชื่อมต่อ)

ERR_SOCKET_BAD_TYPE (ขยาย TypeError )

โยนทิ้งเมื่อมีการใช้ประเภทซ็อกเก็ตที่ไม่ดีในการโต้แย้ง

ERR_SOCKET_BAD_PORT (ขยาย RangeError )

โยนทิ้งเมื่อได้รับพอร์ตที่ไม่ดี

createSocket(options, callback)

สร้างอินสแตน Socket เก็ต ถ้า ()

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ตัวเลือก	สตริง | วัตถุ		เท็จ	ทั้งสตริง ('udp4' หรือ 'udp6') หรือวัตถุตัวเลือก
ตัวเลือก.ประเภท	เชือก		จริง	ครอบครัวของซ็อกเก็ต ต้องเป็น 'udp4' หรือ 'udp6' ที่จำเป็น.
options.reuseAddr	บูลีน	เท็จ	จริง	เมื่อ true socket.bind() จะใช้ที่อยู่ซ้ำ แม้ว่ากระบวนการอื่นจะผูกซ็อกเก็ตไว้แล้วก็ตาม ค่าเริ่มต้น: เท็จ
options.ipv6เท่านั้น	บูลีน	เท็จ	จริง	การตั้งค่า ipv6Only เป็นจริงจะปิดใช้งานการสนับสนุน dual-stack เช่น การเชื่อมโยงไปยังที่อยู่ :: จะไม่ทำให้ 0.0.0.0 ถูกผูกไว้ ค่าเริ่มต้น: เท็จ
options.recvBufferSize	ตัวเลข		จริง	ตั้งค่าซ็อกเก็ต SO_RCVBUF
options.sendBufferSize	ตัวเลข		จริง	ตั้งค่าซ็อกเก็ต SO_SNDBUF
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง	AbortSignal ที่อาจใช้ในการปิดซ็อกเก็ต
โทรกลับ	การทำงาน		จริง	แนบมาเป็นผู้ฟังเหตุการณ์ 'ข้อความ' ไม่จำเป็น.

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ซ็อกเก็ต

Socket (ขยาย EventEmitter )

อินสแตนซ์ใหม่ของ dgram.Socket ถูกสร้างขึ้นโดยใช้ dgram.createSocket() ไม่ควรใช้คีย์เวิร์ดใหม่เพื่อสร้างอินสแตนซ์ dgram.Socket

bind(port, address, callback)

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketbindport-address-callback

ฟังข้อความดาตาแกรมบนพอร์ตที่มีชื่อและที่อยู่เสริม หากไม่ได้ระบุที่อยู่ ระบบปฏิบัติการจะพยายามฟังที่อยู่ทั้งหมด เมื่อการเชื่อมโยงเสร็จสมบูรณ์ เหตุการณ์ 'การฟัง' จะถูกปล่อยออกมา และฟังก์ชันการโทรกลับเสริมจะถูกเรียก

หากการเชื่อมโยงล้มเหลว เหตุการณ์ 'ข้อผิดพลาด' จะถูกส่งออกมา

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ท่าเรือ	ตัวเลข		เท็จ	พอร์ตสำหรับฟังข้อความ
ที่อยู่	เชือก		เท็จ	ที่อยู่ที่จะผูกมัด (0.0.0.0)
โทรกลับ	การทำงาน		เท็จ	โดยไม่มีพารามิเตอร์ เรียกว่าเมื่อผูกเสร็จ

connect(port, host, connectListener)

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketconnectport-address-callback

เชื่อมโยง dgram.Socket กับที่อยู่ระยะไกลและพอร์ต ทุกข้อความที่ส่งโดยหมายเลขอ้างอิงนี้จะถูกส่งไปยังปลายทางนั้นโดยอัตโนมัติ นอกจากนี้ ซ็อกเก็ตจะรับเฉพาะข้อความจากเพียร์ระยะไกลนั้นเท่านั้น การพยายามโทรเชื่อมต่อ() บนซ็อกเก็ตที่เชื่อมต่ออยู่แล้วจะส่งผลให้เกิดข้อยกเว้น ERR_SOCKET_DGRAM_IS_CONNECTED หากไม่มีการระบุที่อยู่ '127.0.0.1' (สำหรับซ็อกเก็ต udp4) หรือ '::1' (สำหรับซ็อกเก็ต udp6) จะถูกใช้เป็นค่าเริ่มต้น เมื่อการเชื่อมต่อเสร็จสมบูรณ์ เหตุการณ์ 'เชื่อมต่อ' จะถูกส่งออกมา และฟังก์ชันการโทรกลับเสริมจะถูกเรียก ในกรณีที่เกิดความล้มเหลว การโทรกลับจะถูกเรียก หรือหากล้มเหลว เหตุการณ์ 'ข้อผิดพลาด' จะถูกส่งออกมา

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ท่าเรือ	ตัวเลข		เท็จ	พอร์ตที่ไคลเอ็นต์ควรเชื่อมต่อด้วย
เจ้าภาพ	เชือก		จริง	โฮสต์ที่ไคลเอนต์ควรเชื่อมต่อด้วย
เชื่อมต่อ Listener	การทำงาน		จริง	พารามิเตอร์ทั่วไปของเมธอด socket.connect() จะถูกเพิ่มเป็นผู้ฟังสำหรับกิจกรรม 'เชื่อมต่อ' หนึ่งครั้ง

disconnect()

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketdisconnect

ฟังก์ชันซิงโครนัสที่ยกเลิกการเชื่อมโยง dgram.Socket ที่เชื่อมต่อจากที่อยู่ระยะไกล การพยายามเรียก Disconnect() บนซ็อกเก็ตที่ไม่ได้เชื่อมต่อหรือไม่ได้เชื่อมต่ออยู่แล้วจะส่งผลให้เกิดข้อยกเว้น ERR_SOCKET_DGRAM_NOT_CONNECTED

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

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketsendmsg-offset-length-port-address-callback

ออกอากาศดาตาแกรมบนซ็อกเก็ต สำหรับซ็อกเก็ตไร้การเชื่อมต่อ จะต้องระบุพอร์ตปลายทางและที่อยู่ ในทางกลับกัน ซ็อกเก็ตที่เชื่อมต่อจะใช้จุดสิ้นสุดระยะไกลที่เกี่ยวข้อง ดังนั้นจึงไม่ต้องตั้งค่าอาร์กิวเมนต์พอร์ตและที่อยู่

อาร์กิวเมนต์ msg มีข้อความที่จะส่ง ลักษณะการทำงานที่แตกต่างกันอาจนำไปใช้ได้ ทั้งนี้ขึ้นอยู่กับประเภทของมัน ถ้า msg เป็น Buffer, TypedArray หรือ DataView ออฟเซ็ตและความยาวจะระบุออฟเซ็ตภายในบัฟเฟอร์ที่ข้อความเริ่มต้นและจำนวนไบต์ในข้อความ ตามลำดับ หาก msg เป็นสตริง ข้อความนั้นจะถูกแปลงเป็นบัฟเฟอร์โดยอัตโนมัติด้วยการเข้ารหัส 'utf8' สำหรับข้อความที่มีอักขระแบบหลายไบต์ อ็อฟเซ็ตและความยาวจะถูกคำนวณตามความยาวไบต์ ไม่ใช่ตำแหน่งอักขระ หาก msg เป็นอาร์เรย์ จะต้องไม่ระบุออฟเซ็ตและความยาว

อาร์กิวเมนต์ที่อยู่เป็นสตริง หากค่าที่อยู่เป็นชื่อโฮสต์ DNS จะถูกนำมาใช้เพื่อแก้ไขที่อยู่ของโฮสต์ หากไม่มีการระบุที่อยู่หรือเป็นโมฆะ '127.0.0.1' (สำหรับซ็อกเก็ต udp4) หรือ '::1' (สำหรับซ็อกเก็ต udp6) จะถูกใช้เป็นค่าเริ่มต้น

หากซ็อกเก็ตไม่ได้ถูกผูกไว้ก่อนหน้านี้ด้วยการเรียกเพื่อผูก ซ็อกเก็ตจะถูกกำหนดหมายเลขพอร์ตแบบสุ่มและถูกผูกไว้กับที่อยู่ "อินเทอร์เฟซทั้งหมด" ('0.0.0.0' สำหรับซ็อกเก็ต udp4, '::0' สำหรับซ็อกเก็ต udp6 .)

ฟังก์ชันการเรียกกลับที่เป็นตัวเลือกอาจถูกระบุให้เป็นวิธีการรายงานข้อผิดพลาด DNS หรือสำหรับการพิจารณาว่าเมื่อใดจึงจะปลอดภัยที่จะนำวัตถุ buf กลับมาใช้ใหม่ การค้นหา DNS จะชะลอเวลาในการส่งอย่างน้อยหนึ่งขีดของลูปเหตุการณ์ Node.js

วิธีเดียวที่จะทราบได้อย่างแน่นอนว่าดาตาแกรมถูกส่งไปแล้วคือการใช้การโทรกลับ หากมีข้อผิดพลาดเกิดขึ้นและได้รับการโทรกลับ ข้อผิดพลาดจะถูกส่งผ่านเป็นอาร์กิวเมนต์แรกไปยังการโทรกลับ หากไม่ได้รับการโทรกลับ ข้อผิดพลาดจะถูกส่งออกมาเป็นเหตุการณ์ 'ข้อผิดพลาด' บนออบเจ็กต์ซ็อกเก็ต

ออฟเซ็ตและความยาวเป็นทางเลือก แต่ต้องตั้งค่าทั้งคู่หากใช้อย่างใดอย่างหนึ่ง ได้รับการสนับสนุนเฉพาะเมื่ออาร์กิวเมนต์แรกคือบัฟเฟอร์, TypedArray หรือ DataView

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ผงชูรส	บัฟเฟอร์ | TypedArray | ดาต้าวิว | สตริง | อาร์เรย์		เท็จ	ข้อความที่จะส่ง
ชดเชย	จำนวนเต็ม		จริง	ออฟเซ็ตในบัฟเฟอร์ที่ข้อความเริ่มต้น
ความยาว	จำนวนเต็ม		จริง	จำนวนไบต์ในข้อความ
ท่าเรือ	จำนวนเต็ม		จริง	พอร์ตปลายทาง
ที่อยู่	เชือก		จริง	ชื่อโฮสต์ปลายทางหรือที่อยู่ IP
โทรกลับ	การทำงาน		จริง	โทรออกเมื่อมีการส่งข้อความ

close(callback)

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketclosecallback

ปิดซ็อกเก็ตที่ซ่อนอยู่และหยุดฟังข้อมูลในนั้น หากมีการระบุการโทรกลับ การโทรนั้นจะถูกเพิ่มเป็นผู้ฟังสำหรับเหตุการณ์ 'ปิด'

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
โทรกลับ	การทำงาน		จริง	เรียกว่าเมื่อการเชื่อมต่อเสร็จสมบูรณ์หรือเกิดข้อผิดพลาด

address()

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketaddress

ส่งกลับวัตถุที่มีข้อมูลที่อยู่สำหรับซ็อกเก็ต สำหรับซ็อกเก็ต UDP ออบเจ็กต์นี้จะประกอบด้วยที่อยู่ ตระกูล และคุณสมบัติพอร์ต

เมธอดนี้จะส่ง EBADF หากถูกเรียกบนซ็อกเก็ตที่ไม่ได้ผูกไว้

ค่าส่งคืน	พิมพ์	คำอธิบาย
ข้อมูลซ็อกเก็ต	วัตถุ	ข้อมูลเกี่ยวกับซ็อกเก็ตท้องถิ่น
socketInfo.address	เชือก	ที่อยู่ IP ของซ็อกเก็ต
ซ็อกเก็ตInfo.port	เชือก	พอร์ตของซ็อกเก็ต
socketInfo.family	เชือก	ตระกูล IP ของซ็อกเก็ต

remoteAddress()

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketremoteaddress

ส่งคืนออบเจ็กต์ที่มีที่อยู่ ตระกูล และพอร์ตของปลายทางระยะไกล วิธีการนี้ส่งข้อยกเว้น ERR_SOCKET_DGRAM_NOT_CONNECTED หากไม่ได้เชื่อมต่อซ็อกเก็ต

ค่าส่งคืน	พิมพ์	คำอธิบาย
ข้อมูลซ็อกเก็ต	วัตถุ	ข้อมูลเกี่ยวกับซอคเก็ตรีโมท
socketInfo.address	เชือก	ที่อยู่ IP ของซ็อกเก็ต
ซ็อกเก็ตInfo.port	เชือก	พอร์ตของซ็อกเก็ต
socketInfo.family	เชือก	ตระกูล IP ของซ็อกเก็ต

setRecvBufferSize(size)

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize

ตั้งค่าตัวเลือกซ็อกเก็ต SO_RCVBUF ตั้งค่าบัฟเฟอร์การรับซ็อกเก็ตสูงสุดเป็นไบต์

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ขนาด	ตัวเลข		เท็จ	ขนาดของบัฟเฟอร์การรับใหม่

setSendBufferSize(size)

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketsetsendbuffersizesize

ตั้งค่าตัวเลือกซ็อกเก็ต SO_SNDBUF ตั้งค่าบัฟเฟอร์การส่งซ็อกเก็ตสูงสุดเป็นไบต์

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ขนาด	ตัวเลข		เท็จ	ขนาดของบัฟเฟอร์การส่งใหม่

getRecvBufferSize()

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize

getSendBufferSize()

เอกสารภายนอก: https://nodejs.org/api/dgram.html#socketgetsendbuffersize

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ตัวเลข	ซ็อกเก็ต SO_SNDBUF ส่งขนาดบัฟเฟอร์เป็นไบต์

DNS

โมดูลนี้เปิดใช้งานการจำแนกชื่อ ตัวอย่างเช่น ใช้เพื่อค้นหาที่อยู่ IP ของชื่อโฮสต์ แม้ว่าจะตั้งชื่อตามระบบชื่อโดเมน (DNS) แต่ก็ไม่ได้ใช้โปรโตคอล DNS ในการค้นหาเสมอไป dns.lookup() ใช้สิ่งอำนวยความสะดวกในการระบบปฏิบัติการเพื่อดำเนินการแก้ไขชื่อ อาจไม่จำเป็นต้องทำการสื่อสารผ่านเครือข่ายใดๆ หากต้องการดำเนินการแก้ไขชื่อเช่นเดียวกับที่แอปพลิเคชันอื่นๆ ในระบบเดียวกันทำ ให้ใช้ dns.lookup()

lookup(hostname, opts, cb)

เอกสารภายนอก: https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback

แก้ไขชื่อโฮสต์ (เช่น example.org ) ลงในบันทึก A (IPv4) หรือ AAAA (IPv6) แรกที่พบ คุณสมบัติตัวเลือกทั้งหมดเป็นทางเลือก หากตัวเลือกเป็นจำนวนเต็ม จะต้องเป็น 4 หรือ 6 หากตัวเลือกเป็น 0 หรือไม่ระบุ ที่อยู่ IPv4 และ IPv6 จะถูกส่งคืนหากพบ

จากเว็บไซต์ node.js...

เมื่อตั้งค่าตัวเลือกทั้งหมดเป็นจริง อาร์กิวเมนต์สำหรับการโทรกลับจะเปลี่ยนเป็น (ผิดพลาด ที่อยู่) โดยที่อยู่เป็นอาร์เรย์ของอ็อบเจ็กต์ที่มีที่อยู่คุณสมบัติและครอบครัว

เมื่อเกิดข้อผิดพลาด err คือออบเจ็กต์ Error โดยที่ err.code คือรหัสข้อผิดพลาด โปรดทราบว่า err.code จะถูกตั้งค่าเป็น 'ENOTFOUND' ไม่เพียงแต่เมื่อไม่มีชื่อโฮสต์เท่านั้น แต่ยังรวมถึงเมื่อการค้นหาล้มเหลวด้วยวิธีอื่น เช่น ไม่มีตัวอธิบายไฟล์ที่พร้อมใช้งาน dns.lookup() ไม่จำเป็นต้องเกี่ยวข้องกับโปรโตคอล DNS การใช้งานใช้สิ่งอำนวยความสะดวกของระบบปฏิบัติการที่สามารถเชื่อมโยงชื่อกับที่อยู่และในทางกลับกัน การใช้งานนี้อาจมีผลกระทบที่ละเอียดอ่อนแต่สำคัญต่อพฤติกรรมของโปรแกรม Node.js ใดๆ โปรดสละเวลาศึกษาส่วนข้อควรพิจารณาในการใช้งานก่อนใช้ dns.lookup()

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ชื่อโฮสต์	เชือก		เท็จ	ชื่อโฮสต์ที่จะแก้ไข
เลือก	วัตถุ		จริง	วัตถุตัวเลือก
opts.ครอบครัว	หมายเลข | เชือก	0	เท็จ	ครอบครัวแผ่นเสียง ต้องเป็น 4, 6 หรือ 0 เพื่อเหตุผลด้านความเข้ากันได้แบบย้อนหลัง 'IPv4' และ 'IPv6' จะถูกตีความว่าเป็น 4 และ 6 ตามลำดับ ค่า 0 บ่งชี้ว่าที่อยู่ IPv4 และ IPv6 ได้รับการส่งคืนทั้งคู่ ค่าเริ่มต้น: 0
ซีบี	การทำงาน		เท็จ	ฟังก์ชันที่จะเรียกหลังจากเมธอดเสร็จสมบูรณ์

DNS.สัญญา

โมดูลนี้เปิดใช้งานการจำแนกชื่อ ตัวอย่างเช่น ใช้เพื่อค้นหาที่อยู่ IP ของชื่อโฮสต์ แม้ว่าจะตั้งชื่อตามระบบชื่อโดเมน (DNS) แต่ก็ไม่ได้ใช้โปรโตคอล DNS ในการค้นหาเสมอไป dns.lookup() ใช้สิ่งอำนวยความสะดวกในการระบบปฏิบัติการเพื่อดำเนินการแก้ไขชื่อ อาจไม่จำเป็นต้องทำการสื่อสารผ่านเครือข่ายใดๆ หากต้องการดำเนินการแก้ไขชื่อเช่นเดียวกับที่แอปพลิเคชันอื่นๆ ในระบบเดียวกันทำ ให้ใช้ dns.lookup()

lookup(hostname, opts)

เอกสารภายนอก: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ชื่อโฮสต์	เชือก		เท็จ	ชื่อโฮสต์ที่จะแก้ไข
เลือก	วัตถุ		จริง	วัตถุตัวเลือก
opts.ครอบครัว	หมายเลข | เชือก	0	เท็จ	ครอบครัวแผ่นเสียง ต้องเป็น 4, 6 หรือ 0 เพื่อเหตุผลด้านความเข้ากันได้แบบย้อนหลัง 'IPv4' และ 'IPv6' จะถูกตีความว่าเป็น 4 และ 6 ตามลำดับ ค่า 0 บ่งชี้ว่าที่อยู่ IPv4 และ IPv6 ได้รับการส่งคืนทั้งคู่ ค่าเริ่มต้น: 0

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

ระบบไฟล์

โมดูลนี้ช่วยให้สามารถโต้ตอบกับระบบไฟล์ในลักษณะจำลองตามฟังก์ชัน POSIX มาตรฐาน

Application Sandbox จำกัดการเข้าถึงระบบไฟล์ โปรดดูเอกสารประกอบ Application Sandbox สำหรับข้อมูลเพิ่มเติม: https://sockets.sh/guides/#working-with-the-file-system-on-ios

วิธีใช้ API ตามสัญญา:

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

วิธีใช้ callback และ async API:

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

access(path, mode , callback)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsopenpath-flags-mode-callback

ตรวจสอบการเข้าถึงไฟล์แบบอะซิงโครนัสสำหรับโหมดที่กำหนดเพื่อ callback เมื่อสำเร็จหรือผิดพลาด

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
โหมด	เชือก	ฉ_ตกลง(0)	จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด fd)		เท็จ

chmod(path, mode, callback)

เอกสารภายนอก: https://nodejs.org/api/fs.html#fschmodpath-mode-callback

การเปลี่ยนแปลงสิทธิ์ของไฟล์แบบอะซิงโครนัส ไม่มีข้อโต้แย้งอื่นนอกเหนือจากข้อยกเว้นที่เป็นไปได้สำหรับการโทรกลับให้เสร็จสิ้น

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
โหมด	ตัวเลข		เท็จ
โทรกลับ	ฟังก์ชั่น (ผิดพลาด)		เท็จ

close(fd, callback)

ปิดตัวอธิบายไฟล์ที่เรียก callback แบบอะซิงโครนัสเมื่อสำเร็จหรือข้อผิดพลาด

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เอฟดี	ตัวเลข		เท็จ
โทรกลับ	ฟังก์ชั่น (ผิดพลาด)		จริง

copyFile()

นี่คือ FunctionDeclaration ชื่อ copyFile ใน fs/index.js มันถูกส่งออก แต่ไม่มีเอกสาร

createReadStream(path, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	fs.ReadStream

createWriteStream(path, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	fs.WriteStream

fstat(fd, options, callback)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fsfstatfd-options-callback

เรียกใช้การโทรกลับด้วย <fs.Stats> สำหรับตัวอธิบายไฟล์ ดูเอกสาร POSIX fstat(2) สำหรับรายละเอียดเพิ่มเติม

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เอฟดี	ตัวเลข		เท็จ	ตัวอธิบายไฟล์
ตัวเลือก	วัตถุ		จริง	วัตถุตัวเลือก
โทรกลับ	การทำงาน		เท็จ	ฟังก์ชั่นที่จะเรียกหลังจากเสร็จสิ้น

open(path, flags , mode , callback)

เปิดไฟล์เรียก callback แบบอะซิงโครนัสเมื่อสำเร็จหรือข้อผิดพลาด

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ธง	เชือก	ร	จริง
โหมด	เชือก	0o666	จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด fd)		เท็จ

opendir(path, options, callback)

เปิดไดเร็กทอรีที่เรียก callback แบบอะซิงโครนัสเมื่อสำเร็จหรือผิดพลาด

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
ตัวเลือก.withFileTypes	บูลีน	เท็จ	จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด fd)		เท็จ

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

อ่านแบบอะซิงโครนัสจากตัวอธิบายไฟล์ที่เปิดอยู่

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เอฟดี	ตัวเลข		เท็จ
บัฟเฟอร์	วัตถุ | บัฟเฟอร์ | TypedArray		เท็จ	บัฟเฟอร์ที่จะเขียนข้อมูลลงไป
ชดเชย	ตัวเลข		เท็จ	ตำแหน่งในบัฟเฟอร์ที่จะเขียนข้อมูลไป
ความยาว	ตัวเลข		เท็จ	จำนวนไบต์ที่จะอ่าน
ตำแหน่ง	หมายเลข | บิ๊กอินท์ | โมฆะ		เท็จ	ระบุตำแหน่งที่จะเริ่มอ่านจากในไฟล์ หากตำแหน่งเป็นโมฆะหรือ -1 ข้อมูลจะถูกอ่านจากตำแหน่งไฟล์ปัจจุบัน และตำแหน่งไฟล์จะได้รับการอัปเดต หากตำแหน่งเป็นจำนวนเต็ม ตำแหน่งไฟล์จะไม่เปลี่ยนแปลง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด, bytesRead, บัฟเฟอร์)		เท็จ

readdir(path, options, callback)

อ่านรายการทั้งหมดในไดเร็กทอรีแบบอะซิงโครนัส

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
ตัวเลือก.withFileTypes	บูลีน	เท็จ	จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด, บัฟเฟอร์)		เท็จ

readFile(path, options, callback)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL | ตัวเลข		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
options.ธง	เชือก	ร	จริง
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด, บัฟเฟอร์)		เท็จ

stat(path, options, callback)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL | ตัวเลข		เท็จ	ชื่อไฟล์หรือคำอธิบายไฟล์
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
options.ธง	เชือก	ร	จริง
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด ข้อมูล)		เท็จ

writeFile(path, data, options, callback)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL | ตัวเลข		เท็จ	ชื่อไฟล์หรือคำอธิบายไฟล์
ข้อมูล	สตริง | บัฟเฟอร์ | TypedArray | ดาต้าวิว | วัตถุ		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
ตัวเลือก.โหมด	เชือก	0o666	จริง
options.ธง	เชือก	ว	จริง
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง
โทรกลับ	ฟังก์ชั่น (ผิดพลาด)		เท็จ

writev()

นี่คือ FunctionDeclaration ชื่อ writev ใน fs/index.js มันถูกส่งออก แต่ไม่มีเอกสาร

FS.สัญญา

access(path, mode, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesaccesspath-mode

ตรวจสอบการเข้าถึงไฟล์แบบอะซิงโครนัส

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
โหมด	เชือก		จริง
ตัวเลือก	วัตถุ		จริง

chmod(path, mode)

เอกสารภายนอก: https://nodejs.org/api/fs.html#fspromiseschmodpath-mode

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
โหมด	ตัวเลข		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

mkdir(path, options)

สร้างไดเร็กทอรีแบบอะซิงโครนัส

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง		เท็จ	เส้นทางที่จะสร้าง
ตัวเลือก	วัตถุ		เท็จ	อาร์กิวเมนต์ตัวเลือกเสริมอาจเป็นโหมดการระบุจำนวนเต็ม (สิทธิ์และบิตเหนียว) หรืออ็อบเจ็กต์ที่มีคุณสมบัติโหมดและคุณสมบัติแบบเรียกซ้ำที่ระบุว่าควรสร้างไดเร็กทอรีพาเรนต์หรือไม่ การเรียก fs.mkdir() เมื่อพาธเป็นไดเร็กทอรีที่มีอยู่ส่งผลให้เกิดข้อผิดพลาดเฉพาะเมื่อการเรียกซ้ำเป็นเท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	พริมมิส	เมื่อสำเร็จ เติมเต็มด้วย undefible หากการเรียกซ้ำเป็นเท็จ หรือสร้างพาธไดเร็กทอรีแรกหากการเรียกซ้ำเป็นจริง

open(path, flags, mode)

เอกสารภายนอก: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode

เปิดไฟล์แบบอะซิงโครนัส

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ธง	เชือก		เท็จ	ค่าเริ่มต้น: 'r'
โหมด	เชือก		เท็จ	ค่าเริ่มต้น: 0o666

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

opendir(path, options)

เอกสารภายนอก: https://nodejs.org/api/fs.html#fspromisesopendirpath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
options.bufferSize	ตัวเลข	32	จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <FileSystem,Dir>

readdir(path, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	เชือก	utf8	จริง
ตัวเลือก.withFileTypes	บูลีน	เท็จ	จริง

readFile(path, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	เชือก		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	สตริง | โมฆะ	โมฆะ	จริง
options.ธง	เชือก	ร	จริง
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา<บัฟเฟอร์	สตริง>

stat(path, options)

เอกสารภายนอก: https://nodejs.org/api/fs.html#fspromisesstatpath-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือก.bigint	บูลีน	เท็จ	จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

writeFile(path, data, options)

เอกสารภายนอก: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เส้นทาง	สตริง | บัฟเฟอร์ | URL | FileHandle		เท็จ	ชื่อไฟล์หรือ FileHandle
ข้อมูล	สตริง | บัฟเฟอร์ | อาร์เรย์ | ดาต้าวิว | TypedArray | ลำธาร		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือกการเข้ารหัส	สตริง | โมฆะ	utf8	เท็จ
ตัวเลือก.โหมด	ตัวเลข	0o666	เท็จ
options.ธง	เชือก	ว	เท็จ
ตัวเลือกสัญญาณ	ยกเลิกสัญญาณ		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

FS.สตรีม

DEFAULT_STREAM_HIGH_WATER_MARK

นี่คือ VariableDeclaration ชื่อ DEFAULT_STREAM_HIGH_WATER_MARK ใน fs/stream.js ซึ่งถูกส่งออก แต่ไม่มีเอกสาร

ReadStream (ขยาย Readable )

กระแส Readable สำหรับ FileHandle

constructor()

ตัวสร้างคลาส ReadStream

setHandle(handle)

ตั้งค่าตัวจัดการไฟล์สำหรับ ReadStream

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รับมือ	FileHandle		เท็จ

highWaterMark()

ขนาดบัฟเฟอร์สูงสุดสำหรับ ReadStream

path()

เส้นทางสัมพัทธ์หรือสัมบูรณ์ของ FileHandle ต้นแบบ

pending()

true หากสตรีมอยู่ในสถานะรอดำเนินการ

emit()

จัดการการตั้งค่า shouldEmitClose จาก options.emitClose ในตัวสร้าง

WriteStream (ขยาย Writable )

สตรีม Writable สำหรับ FileHandle

constructor()

ตัวสร้างคลาส WriteStream

setHandle(handle)

ตั้งค่าตัวจัดการไฟล์สำหรับ WriteStream

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รับมือ	FileHandle		เท็จ

highWaterMark()

ขนาดบัฟเฟอร์สูงสุดสำหรับ Writetream

path()

เส้นทางสัมพัทธ์หรือสัมบูรณ์ของ FileHandle ต้นแบบ

pending()

true หากสตรีมอยู่ในสถานะรอดำเนินการ

emit()

จัดการการตั้งค่า shouldEmitClose จาก options.emitClose ในตัวสร้าง

FileReadStream

นี่คือ VariableDeclaration ชื่อ FileReadStream ใน fs/stream.js มันถูกส่งออก แต่ไม่มีเอกสาร

FileWriteStream

นี่คือ VariableDeclaration ชื่อ FileWriteStream ใน fs/stream.js มันถูกส่งออก แต่ไม่มีเอกสาร

ไอพีซี

นี่คือ API ระดับต่ำที่คุณไม่ต้องการ เว้นแต่ว่าคุณกำลังใช้งานไลบรารีที่อยู่ด้านบนของ Socket SDK แอป Socket SDK มีกระบวนการสองหรือสามกระบวนการ

• กระบวนการ Render UI ที่ใช้งาน HTML, CSS และ JS
• กระบวนการ Bridge ซึ่งเป็นชั้นโค้ดบางๆ ที่จัดการทุกอย่าง
• กระบวนการ Main สำหรับแอปที่ต้องรันงานประมวลผลที่หนักกว่า และไม่เหมือนกับอิเล็กตรอน มันเป็นทางเลือก

กระบวนการ Bridge จัดการกระบวนการ Render และ Main และยังอาจเป็นนายหน้าข้อมูลระหว่างกันอีกด้วย

กระบวนการผูกใช้อินพุตและเอาต์พุตมาตรฐานเป็นวิธีการสื่อสาร ข้อมูลที่เขียนไปยังจุดสิ้นสุดการเขียนของไปป์จะถูกบัฟเฟอร์โดย OS จนกระทั่งถูกอ่านจากจุดสิ้นสุดการอ่านของไปป์

โปรโตคอล IPC ใช้รูปแบบคล้าย URI ที่เรียบง่าย ข้อมูลถูกส่งผ่านเป็น ArrayBuffers

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

postMessage()

นี่คือ FunctionDeclaration ชื่อ postMessage ใน ipc.js มันถูกส่งออก แต่ไม่มีเอกสาร

ตกลง

แสดงถึงสถานะ OK IPC

ข้อผิดพลาด

แสดงถึงสถานะข้อผิดพลาด IPC

หมดเวลา

หมดเวลาเป็นมิลลิวินาทีสำหรับคำขอ IPC

เปิดใช้งาน kDebug แล้ว

สัญลักษณ์สำหรับคุณสมบัติ ipc.debug.enabled

parseSeq(seq, options)

แยกวิเคราะห์ seq เป็นค่าจำนวนเต็ม

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ลำดับ	สตริง | ตัวเลข		เท็จ
ตัวเลือก	วัตถุ		จริง
ตัวเลือก.bigint	บูลีน	เท็จ	เท็จ

debug(enable)

หาก debug.enabled === true เอาต์พุตการดีบักจะถูกพิมพ์ไปยังคอนโซล

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เปิดใช้งาน	บูลีน		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	บูลีน

Message (ขยาย URL )

คอนเทนเนอร์สำหรับข้อความ IPC ตามรูปแบบ ipc:// URI

PROTOCOL()

โปรโตคอลที่คาดหวังสำหรับข้อความ IPC

from(input, params)

สร้างอินสแตนซ์ Message จากอินพุตที่หลากหลาย

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ป้อนข้อมูล	สตริง | URL | ข้อความ | บัฟเฟอร์ | วัตถุ		เท็จ
พารามิเตอร์	วัตถุ | สตริง | URLSearchพารามิเตอร์		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ข้อความ

isValidInput(input)

เพรดิเคตเพื่อตรวจสอบว่า input ถูกต้องสำหรับการสร้างอินสแตนซ์ Message ใหม่หรือไม่

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ป้อนข้อมูล	สตริง | URL | ข้อความ | บัฟเฟอร์ | วัตถุ		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	บูลีน

constructor(input)

ตัวสร้างคลาส Message

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ป้อนข้อมูล	สตริง | URL		เท็จ

command()

ชื่อข้อความ IPC ที่คำนวณ

name()

ชื่อข้อความ IPC ที่คำนวณ

id()

ค่า id ที่คำนวณสำหรับคำสั่ง

seq()

ค่า seq (ลำดับ) ที่คำนวณสำหรับคำสั่ง

value()

ค่าข้อความที่คำนวณอาจกำหนดไว้ในพารามิเตอร์ข้อความ ค่านี้จะถูกถอดรหัสโดยอัตโนมัติ แต่ไม่ถือเป็น JSON

index()

ค่า index ที่คำนวณสำหรับคำสั่งที่อาจอ้างอิงถึงดัชนีหน้าต่างที่คำสั่งกำหนดขอบเขตหรือมาจาก หากไม่ได้ระบุในพารามิเตอร์ข้อความ ค่าดีฟอลต์นี้จะมีค่าเริ่มต้นเป็น -1

json()

ค่าที่คำนวณแยกวิเคราะห์เป็น JSON ค่านี้เป็น null หากไม่มีค่านี้หรือเป็น JSON ที่ไม่ถูกต้อง

params()

คำนวณอ็อบเจ็กต์แบบอ่านอย่างเดียวของพารามิเตอร์ข้อความ

entries()

ส่งกลับพารามิเตอร์ที่คำนวณเป็นรายการ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	อาร์เรย์<อาร์เรย์<สตริง,ผสม>>

set(key, value)

ตั้ง value พารามิเตอร์ตาม key

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สำคัญ	เชือก		เท็จ
ค่า	ผสม		เท็จ

get(key, defaultValue)

รับค่าพารามิเตอร์ตาม key

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สำคัญ	เชือก		เท็จ
ค่าดีฟอลต์	ผสม		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ผสม

delete(key)

ลบพารามิเตอร์ด้วย key

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สำคัญ	เชือก		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	บูลีน

keys()

คีย์พารามิเตอร์ที่คำนวณ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	อาร์เรย์

values()

ค่าพารามิเตอร์ที่คำนวณ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	อาร์เรย์

has(key)

เพรดิเคตเพื่อพิจารณาว่ามี key พารามิเตอร์อยู่ในพารามิเตอร์หรือไม่

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สำคัญ	เชือก		เท็จ

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	บูลีน

toJSON()

แปลงอินสแตนซ์ Message ให้เป็นออบเจ็กต์ JSON ธรรมดา

ผลลัพธ์

ประเภทผลลัพธ์ที่ใช้ภายในสำหรับจัดการค่าผลลัพธ์ IPC จากเลเยอร์เนทิฟที่อยู่ในรูปแบบของ { err?, data? } . คุณสมบัติ data และ err บนวัตถุประเภทนี้อยู่ในรูปแบบทูเพิลและเข้าถึงได้ที่ [data?,err?]

from(result, maybeError, maybeSource)

สร้างอินสแตนซ์ Result จากอินพุตที่อาจเป็นวัตถุเช่น { err?, data? } อินสแตนซ์ Error หรือเพียงแค่ data

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ผลลัพธ์	วัตถุ | ผิดพลาด | ผสม		จริง
อาจจะเกิดข้อผิดพลาด	ข้อผิดพลาด		จริง
บางทีแหล่งที่มา	เชือก		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ผลลัพธ์

constructor(err , data , source )

ตัวสร้างคลาส Result

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ผิดพลาด	ข้อผิดพลาด	โมฆะ	จริง
ข้อมูล	วัตถุ	โมฆะ	จริง
แหล่งที่มา	เชือก	ไม่ได้กำหนด	จริง

length()

ความยาวผลลัพธ์ที่คำนวณได้

ready()

รอให้เลเยอร์ IPC ดั้งเดิมพร้อมและเปิดเผยบนวัตถุหน้าต่างส่วนกลาง

sendSync(command, params)

ส่งคำสั่ง IPC แบบซิงโครนัสผ่าน XHR โดยส่งคืน Result เมื่อสำเร็จหรือผิดพลาด

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สั่งการ	เชือก		เท็จ
พารามิเตอร์	วัตถุ | เชือก		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	ผลลัพธ์

emit(name, value, target , options)

ปล่อยเหตุการณ์ที่จะจัดส่งบนวัตถุ window

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ชื่อ	เชือก		เท็จ
ค่า	ผสม		เท็จ
เป้า	เป้าหมายเหตุการณ์	หน้าต่าง	จริง
ตัวเลือก	วัตถุ		จริง

resolve(seq, value)

แก้ไขคำขอตาม seq ด้วยค่าที่เป็นไปได้

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ลำดับ	เชือก		เท็จ
ค่า	ผสม		เท็จ

send(command, value)

ส่งคำขอคำสั่ง async IPC พร้อมพารามิเตอร์

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สั่งการ	เชือก		เท็จ
ค่า	ผสม		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

write(command, params, buffer, options)

ส่งคำขอคำสั่ง async IPC พร้อมพารามิเตอร์และไบต์ที่บัฟเฟอร์

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สั่งการ	เชือก		เท็จ
พารามิเตอร์	วัตถุ		จริง
บัฟเฟอร์	บัฟเฟอร์ | ประเภทอาร์เรย์ | อาร์เรย์บัฟเฟอร์ | สตริง | อาร์เรย์		จริง
ตัวเลือก	วัตถุ		จริง

request(command, params, options)

ส่งคำขอคำสั่ง async IPC พร้อมพารามิเตอร์ที่ร้องขอการตอบสนองด้วยไบต์ที่บัฟเฟอร์

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
สั่งการ	เชือก		เท็จ
พารามิเตอร์	วัตถุ		จริง
ตัวเลือก	วัตถุ		จริง

createBinding(domain, ctx)

โรงงานสำหรับสร้าง IPC API ที่ใช้พร็อกซี

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
โดเมน	เชือก		เท็จ
กล่องข้อความ	ฟังก์ชั่น | วัตถุ		จริง
ctx.ค่าเริ่มต้น	เชือก		จริง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	หนังสือมอบฉันทะ

ระบบปฏิบัติการ

โมดูลนี้ให้ข้อมูลระบบที่เป็นมาตรฐานจากระบบปฏิบัติการหลักทั้งหมด

arch()

นี่คือ FunctionDeclaration ชื่อ arch ใน os.js มันถูกส่งออก แต่ไม่มีเอกสาร

networkInterfaces()

นี่คือ FunctionDeclaration ชื่อ networkInterfaces ใน os.js มันถูกส่งออก แต่ไม่มีเอกสาร

platform()

นี่คือ platform ที่มีชื่อ FunctionDeclaration ใน os.js ซึ่งถูกส่งออก แต่ไม่มีเอกสาร

type()

นี่คือ FunctionDeclaration ที่มีชื่อ type ใน os.js มันถูกส่งออก แต่ไม่มีเอกสาร

isWindows()

นี่คือ FunctionDeclaration ชื่อ isWindows ใน os.js มันถูกส่งออก แต่ไม่มีเอกสาร

tmpdir()

นี่คือ FunctionDeclaration ชื่อ tmpdir ใน os.js มันถูกส่งออก แต่ไม่มีเอกสาร

EOL

นี่คือ VariableDeclaration ชื่อ EOL ใน os.js ซึ่งถูกส่งออก แต่ไม่มีเอกสาร

เส้นทาง

เส้นทาง

นี่คือ ClassDeclaration ชื่อ Path ใน path/path.js มันถูกส่งออก แต่ไม่มีเอกสาร

cwd(opts)

คำนวณไดเร็กทอรีการทำงานปัจจุบันสำหรับพาธ

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เลือก	วัตถุ		จริง
opts.posix ตั้งค่าเป็น true เพื่อบังคับเส้นทางสไตล์ POSIX	บูลีน		จริง

constructor(opts)

ตัวสร้างคลาส Path

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เลือก	วัตถุ		จริง
opts.root	เชือก		จริง
opts.ฐาน	เชือก		จริง
opts.ชื่อ	เชือก		จริง
opts.dir	เชือก		จริง
opts.ext	เชือก		จริง

resolve()

normalize()

กระบวนการ

homedir()

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	เชือก	โฮมไดเร็กทอรีของผู้ใช้ปัจจุบัน

exit(code)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
รหัส	ตัวเลข	0	จริง	รหัสทางออก. ค่าเริ่มต้น: 0

รันไทม์

จัดเตรียมวิธีการเฉพาะรันไทม์

หน้าต่างปัจจุบัน

นี่คือ VariableDeclaration ชื่อ currentWindow ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

แก้ปัญหา

นี่คือ VariableDeclaration ชื่อ debug ใน runtime.js ซึ่งถูกส่งออก แต่ไม่มีเอกสาร

กำหนดค่า

นี่คือ VariableDeclaration ชื่อ config ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

send()

นี่คือ FunctionDeclaration ชื่อ send ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

getWindows()

นี่คือ FunctionDeclaration ชื่อ getWindows ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

openExternal()

นี่คือ FunctionDeclaration ชื่อ openExternal ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

exit(options)

ออกจากกระบวนการแบ็กเอนด์แล้วออกจากกระบวนการเรนเดอร์ โค้ดทางออกที่ใช้คือโค้ดทางออกสุดท้ายของระบบปฏิบัติการ

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ตัวเลือก	วัตถุ		เท็จ	วัตถุตัวเลือก

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

setTitle(options)

ตั้งชื่อเรื่องของหน้าต่าง (ถ้ามี)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ตัวเลือก	วัตถุ		เท็จ	วัตถุตัวเลือก

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

inspect()

นี่คือ FunctionDeclaration ชื่อ inspect ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

show(opts)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เลือก	วัตถุ		เท็จ	วัตถุตัวเลือก

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

hide(opts)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เลือก	วัตถุ		เท็จ	วัตถุตัวเลือก

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

navigate(opts)

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
เลือก	วัตถุ		เท็จ	วัตถุตัวเลือก
opts.หน้าต่าง	ตัวเลข	หน้าต่างปัจจุบัน	เท็จ	ดัชนีของหน้าต่าง
opts.url	ตัวเลข		เท็จ	เส้นทางไปยังไฟล์ HTML เพื่อโหลดเข้าสู่หน้าต่าง

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา <ipc.Result>

setWindowBackgroundColor()

นี่คือ FunctionDeclaration ชื่อ setWindowBackgroundColor ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

setContextMenu(options)

เปิดเมนูตามบริบทดั้งเดิม

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ตัวเลือก	วัตถุ		เท็จ	วัตถุตัวเลือก

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

setSystemMenuItemEnabled()

นี่คือ FunctionDeclaration ชื่อ setSystemMenuItemEnabled ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

setSystemMenu(options)

ตั้งค่าเมนูดั้งเดิมสำหรับแอป

Socket Runtime มี DSL ที่เรียบง่ายซึ่งทำให้ง่ายต่อการสร้างระบบเนทีฟข้ามแพลตฟอร์มและเมนูบริบท

เมนูจะถูกสร้างขึ้นในเวลาดำเนินการ สามารถสร้างได้จากกระบวนการหลักหรือกระบวนการเรนเดอร์ สามารถสร้างใหม่ได้ทันทีโดยการเรียกเมธอด setSystemMenu

วิธีการใช้สตริง นี่คือตัวอย่างเมนู เครื่องหมายอัฒภาคมีนัยสำคัญ หมายถึง จุดสิ้นสุดของเมนู ใช้ขีดล่างเมื่อไม่มีแป้นคันเร่ง ตัวแก้ไขเป็นทางเลือก และตัวเลือกเมนู OS ที่รู้จักกันดี เช่น เมนูแก้ไข จะได้รับตัวเร่งความเร็วโดยอัตโนมัติโดยคุณไม่จำเป็นต้องระบุ

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

ตัวคั่น

หากต้องการสร้างตัวคั่น ให้ใช้ขีดกลาง 3 อัน ---

ตัวปรับแต่งคันเร่ง

ตัวแก้ไขการเร่งความเร็วถูกใช้เป็นตัวบ่งชี้ด้วยภาพ แต่ไม่มีผลกระทบที่สำคัญ เนื่องจากการผูกคีย์จริงเสร็จสิ้นใน Listener เหตุการณ์

ตัวพิมพ์ใหญ่แสดงว่ามีการดัดแปลงคันเร่งด้วยปุ่ม Shift

ตัวเร่งความเร็วเพิ่มเติมคือ Meta , Control , Option คั่นด้วยเครื่องหมายจุลภาค หากไม่สามารถใช้กับแพลตฟอร์มได้ ก็จะถูกละเว้น

บน MacOS Meta จะเหมือนกับ Command .

รายการปิดการใช้งาน

หากคุณต้องการปิดการใช้งานรายการเมนู เพียงเติมคำนำหน้ารายการด้วย ! อักขระ. ซึ่งจะทำให้รายการปรากฏว่าปิดใช้งานเมื่อเมนูของระบบแสดงผล

เมนูย่อย

เรารู้สึกว่าเมนูที่ซ้อนกันเป็นการต่อต้านรูปแบบ เราไม่ได้ใช้พวกเขา หากคุณมีข้อโต้แย้งที่หนักแน่นสำหรับพวกเขาและคำขอดึงข้อมูลที่เรียบง่ายซึ่งทำให้พวกเขาใช้งานได้ เราอาจพิจารณาพวกเขา

การจัดการเหตุการณ์

เมื่อเปิดใช้งานรายการเมนู มันจะเพิ่มเหตุการณ์ menuItemSelected ในโค้ดส่วนหน้า จากนั้นคุณสามารถสื่อสารกับโค้ดแบ็กเอนด์ของคุณได้หากต้องการจากที่นั่น

ตัวอย่างเช่น หากเลือกรายการ Apple จากเมนู Other ...

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

การโต้แย้ง	พิมพ์	ค่าเริ่มต้น	ไม่จำเป็น	คำอธิบาย
ตัวเลือก	วัตถุ		เท็จ	วัตถุตัวเลือก
options.value	เชือก		เท็จ	เค้าโครงเมนู
ตัวเลือก.ดัชนี	ตัวเลข		เท็จ	หน้าต่างที่จะกำหนดเป้าหมาย (ถ้ามี)

ค่าส่งคืน	พิมพ์	คำอธิบาย
ไม่ระบุ	สัญญา

reload()

นี่คือ FunctionDeclaration ชื่อ reload ใน runtime.js มันถูกส่งออก แต่ไม่มีเอกสาร

ลำธาร