واجهة برمجة تطبيقات عالية المستوى ومتعددة المنصات لـ Bluetooth Pub-Sub
Bluetooth
(يمتد EventEmitter
)إنشاء مثيل لخدمة Bluetooth.
constructor(serviceId)
المُنشئ هو خاصية نموذجية تم تعيينها على 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 إلى دعم proto ويحتوي على تطبيق مصفوفة مكتوبة بالأخطاء.
إذا كان 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 إلى دعم proto ويحتوي على تطبيق مصفوفة مكتوبة بالأخطاء.
إذا كان 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 إلى دعم proto ويحتوي على تطبيق مصفوفة مكتوبة بالأخطاء.
إذا كان 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 إلى دعم proto ويحتوي على تطبيق مصفوفة مكتوبة بالأخطاء.
يقوم مُنشئ Buffer بإرجاع مثيلات Uint8Array
التي تم تغيير نموذجها الأولي إلى Buffer.prototype
. علاوة على ذلك، Buffer
هو فئة فرعية من Uint8Array
، وبالتالي فإن المثيلات التي تم إرجاعها ستحتوي على جميع أساليب العقدة Buffer
وطرق Uint8Array
. يعمل تدوين القوس المربع كما هو متوقع - فهو يُرجع ثمانيًا واحدًا.
يبقى النموذج الأولي Uint8Array
بدون تعديل.
يكافئ وظيفيًا Buffer(arg, encoding) ولكنه يلقي خطأ TypeError إذا كانت القيمة رقمًا. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
يكافئ وظيفيًا Buffer(arg, encoding) ولكنه يلقي خطأ TypeError إذا كانت القيمة رقمًا. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
يكافئ وظيفيًا Buffer(arg, encoding) ولكنه يلقي خطأ TypeError إذا كانت القيمة رقمًا. Buffer.from(str[, encoding]) Buffer.from(array) Buffer.from(buffer) Buffer.from(arrayBuffer[, byteOffset[, length]])
يكافئ وظيفيًا Buffer(arg, encoding) ولكنه يلقي خطأ TypeError إذا كانت القيمة رقمًا. Buffer.from(str[, encoding]) 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)، يقوم افتراضيًا بإنشاء مثيل Buffer غير مملوء بالصفر.
أي ما يعادل SlowBuffer(num)، يقوم افتراضيًا بإنشاء مثيل Buffer غير مملوء بالصفر.
أي ما يعادل SlowBuffer(num)، يقوم افتراضيًا بإنشاء مثيل Buffer غير مملوء بالصفر.
أي ما يعادل SlowBuffer(num)، يقوم افتراضيًا بإنشاء مثيل Buffer غير مملوء بالصفر.
بعض الأساليب عالية المستوى حول واجهة برمجة crypto.subtle
للحصول على بايتات وتجزئة عشوائية.
واجهة برمجة تطبيقات ويب كريبتو
getRandomValues(buffer)
المستندات الخارجية: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues
إنشاء قيم عشوائية قوية تشفيريًا في buffer
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
عازلة | TypedArray | خطأ شنيع |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | TypedArray |
الحد الأقصى للحجم الإجمالي للبايتات العشوائية لكل صفحة
الحد الأقصى للحجم الإجمالي للبايتات العشوائية.
الحد الأقصى لإجمالي المبلغ المخصص لكل صفحة من البايتات (الحد الأقصى/الحصة النسبية)
randomBytes(size)
توليد بايت عشوائي size
.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
مقاس | رقم | خطأ شنيع | عدد البايتات المراد إنشاؤها. يجب ألا يزيد الحجم عن 2**31 - 1. |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | المخزن المؤقت | وعد يتم حله باستخدام مثيل مأخذ التوصيل.Buffer بالبايتات العشوائية. |
createDigest(algorithm, message)
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
خوارزمية | خيط | خطأ شنيع | SHA-1 | |
رسالة | المخزن المؤقت | المصفوفة المكتوبة | عرض البيانات | خطأ شنيع | مثيل لـsocket.Buffer أو TypedArray أو Dataview. |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد | وعد يتم حله باستخدام مثيل مأخذ التوصيل.Buffer مع التجزئة. |
توفر هذه الوحدة تطبيقًا لمآخذ مخطط بيانات 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") أو كائن خيارات | |
options.type | خيط | حقيقي | عائلة المقبس. يجب أن يكون إما "udp4" أو "udp6". مطلوب. | |
options.reuseAddr | منطقية | خطأ شنيع | حقيقي | عندما يقوم true المقبس.bind() بإعادة استخدام العنوان، حتى لو كانت عملية أخرى قد ربطت مأخذ توصيل عليه بالفعل. الافتراضي: خطأ. |
options.ipv6Only | منطقية | خطأ شنيع | حقيقي | سيؤدي ضبط ipv6Only على true إلى تعطيل دعم المكدس المزدوج، أي الارتباط بالعنوان :: لن يجعل 0.0.0.0 مرتبطًا. الافتراضي: خطأ. |
options.recvBufferSize | رقم | حقيقي | يضبط قيمة مأخذ التوصيل SO_RCVBUF. | |
options.sendBufferSize | رقم | حقيقي | يضبط قيمة مأخذ التوصيل SO_SNDBUF. | |
options.signal | AbortSignal | حقيقي | 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 بعنوان ومنفذ بعيد. يتم إرسال كل رسالة يتم إرسالها بواسطة هذا المؤشر تلقائيًا إلى تلك الوجهة. كما أن المقبس سيستقبل فقط الرسائل من ذلك النظير البعيد. ستؤدي محاولة الاتصال بـconnect() على مأخذ توصيل متصل بالفعل إلى حدوث استثناء ERR_SOCKET_DGRAM_IS_CONNECTED. إذا لم يتم توفير العنوان، فسيتم استخدام "127.0.0.1" (لمقابس udp4) أو "::1" (لمقابس udp6) بشكل افتراضي. بمجرد اكتمال الاتصال، يُطلق حدث "الاتصال" ويتم استدعاء وظيفة رد الاتصال الاختيارية. في حالة الفشل، يتم استدعاء رد الاتصال أو، في حالة الفشل، يتم إصدار حدث "خطأ".
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
ميناء | رقم | خطأ شنيع | المنفذ الذي يجب على العميل الاتصال به. | |
يستضيف | خيط | حقيقي | المضيف يجب على العميل الاتصال به. | |
ConnectListener | وظيفة | حقيقي | المعلمة الشائعة لطرق المقبس ()socket.connect. ستتم إضافته كمستمع لحدث "الاتصال" مرة واحدة. |
disconnect()
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketdisconnect
دالة متزامنة تعمل على فصل dgram.Socket المتصل عن عنوانه البعيد. ستؤدي محاولة استدعاء قطع الاتصال () على مأخذ توصيل غير منضم أو منفصل بالفعل إلى حدوث استثناء 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 على الرسالة التي سيتم إرسالها. اعتمادًا على نوعه، يمكن تطبيق سلوك مختلف. إذا كانت الرسالة عبارة عن مخزن مؤقت، أو أي TypedArray أو DataView، فإن الإزاحة والطول يحددان الإزاحة داخل المخزن المؤقت حيث تبدأ الرسالة وعدد البايتات في الرسالة، على التوالي. إذا كانت msg عبارة عن سلسلة، فسيتم تحويلها تلقائيًا إلى مخزن مؤقت بتشفير "utf8". بالنسبة للرسائل التي تحتوي على أحرف متعددة البايت، سيتم حساب الإزاحة والطول فيما يتعلق بطول البايت وليس موضع الحرف. إذا كانت الرسالة عبارة عن مصفوفة، فلا يجب تحديد الإزاحة والطول.
وسيطة العنوان عبارة عن سلسلة. إذا كانت قيمة العنوان هي اسم مضيف، فسيتم استخدام DNS لتحليل عنوان المضيف. إذا لم يتم توفير العنوان أو كان خاليًا، فسيتم استخدام '127.0.0.1' (لمقابس udp4) أو '::1' (لمقابس udp6) بشكل افتراضي.
إذا لم يتم ربط المقبس مسبقًا باستدعاء للربط، فسيتم تعيين رقم منفذ عشوائي للمقبس ويكون مرتبطًا بعنوان "جميع الواجهات" ('0.0.0.0' لمآخذ توصيل udp4، '::0' لمآخذ توصيل udp6 .)
قد يتم تحديد وظيفة رد اتصال اختيارية كوسيلة للإبلاغ عن أخطاء DNS أو لتحديد متى يكون من الآمن إعادة استخدام كائن buf. تؤدي عمليات بحث DNS إلى تأخير وقت الإرسال لعلامة واحدة على الأقل من حلقة أحداث Node.js.
الطريقة الوحيدة للتأكد من إرسال مخطط البيانات هي استخدام رد الاتصال. إذا حدث خطأ وتم تقديم رد اتصال، فسيتم تمرير الخطأ باعتباره الوسيط الأول لاستدعاء الاتصال. إذا لم يتم إعطاء رد اتصال، فسيتم إصدار الخطأ كحدث "خطأ" على كائن مأخذ التوصيل.
يعد الإزاحة والطول اختياريين ولكن يجب ضبطهما في حالة استخدام أي منهما. يتم دعمها فقط عندما تكون الوسيطة الأولى عبارة عن Buffer، أو TypedArray، أو DataView.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
رسالة | المخزن المؤقت | المصفوفة المكتوبة | عرض البيانات | سلسلة | صفيف | خطأ شنيع | الرسالة المراد إرسالها. | |
إزاحة | عدد صحيح | حقيقي | الإزاحة في المخزن المؤقت حيث تبدأ الرسالة. | |
طول | عدد صحيح | حقيقي | عدد البايتات في الرسالة. | |
ميناء | عدد صحيح | حقيقي | ميناء الوجهة. | |
عنوان | خيط | حقيقي | اسم المضيف الوجهة أو عنوان IP. | |
أتصل مرة أخرى | وظيفة | حقيقي | تم الاتصال به عندما تم إرسال الرسالة. |
close(callback)
المستندات الخارجية: https://nodejs.org/api/dgram.html#socket Closecallback
أغلق المقبس الأساسي وتوقف عن الاستماع للبيانات الموجودة عليه. إذا تم توفير رد اتصال، فسيتم إضافته كمستمع للحدث "إغلاق".
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
أتصل مرة أخرى | وظيفة | حقيقي | يتم الاتصال به عند اكتمال الاتصال أو عند حدوث خطأ. |
address()
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketaddress
إرجاع كائن يحتوي على معلومات العنوان للمقبس. بالنسبة لمآخذ توصيل UDP، سيحتوي هذا الكائن على خصائص العنوان والعائلة والمنفذ.
تقوم هذه الطريقة بطرح EBADF إذا تم استدعاؤها على مأخذ توصيل غير منضم.
قيمة الإرجاع | يكتب | وصف |
---|---|---|
معلومات المقبس | هدف | معلومات حول المقبس المحلي |
java.socketInfo.address | خيط | عنوان IP الخاص بالمقبس |
//socketInfo.port | خيط | منفذ المقبس |
المقبسInfo.family | خيط | عائلة IP للمقبس |
remoteAddress()
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketremoteaddress
إرجاع كائن يحتوي على العنوان والعائلة والمنفذ الخاص بنقطة النهاية البعيدة. تطرح هذه الطريقة استثناء ERR_SOCKET_DGRAM_NOT_CONNECTED إذا لم يكن المقبس متصلاً.
قيمة الإرجاع | يكتب | وصف |
---|---|---|
معلومات المقبس | هدف | معلومات حول المقبس البعيد |
java.socketInfo.address | خيط | عنوان IP الخاص بالمقبس |
//socketInfo.port | خيط | منفذ المقبس |
المقبسInfo.family | خيط | عائلة IP للمقبس |
setRecvBufferSize(size)
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketsetrecvbuffersizesize
يضبط خيار مأخذ التوصيل SO_RCVBUF. يضبط الحد الأقصى للمأخذ المؤقت لتلقي المخزن المؤقت بالبايت.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
مقاس | رقم | خطأ شنيع | حجم المخزن المؤقت الجديد للتلقي |
setSendBufferSize(size)
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketsendbuffersizesize
يضبط خيار مأخذ التوصيل SO_SNDBUF. يضبط الحد الأقصى للمخزن المؤقت لإرسال المقبس بالبايت.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
مقاس | رقم | خطأ شنيع | حجم المخزن المؤقت للإرسال الجديد |
getRecvBufferSize()
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketgetrecvbuffersize
getSendBufferSize()
المستندات الخارجية: https://nodejs.org/api/dgram.html#socketgetsendbuffersize
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | رقم | يرسل مأخذ توصيل SO_SNDBUF حجم المخزن المؤقت بالبايت. |
تتيح هذه الوحدة تحليل الاسم. على سبيل المثال، استخدمه للبحث عن عناوين 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 هو كائن خطأ، حيث err.code هو رمز الخطأ. ضع في اعتبارك أنه سيتم تعيين err.code على "ENOTFOUND" ليس فقط في حالة عدم وجود اسم المضيف ولكن أيضًا عند فشل البحث بطرق أخرى مثل عدم توفر واصفات الملفات. ليس بالضرورة أن يكون لـ dns.lookup() أي علاقة ببروتوكول DNS. يستخدم التنفيذ أداة نظام تشغيل يمكنها ربط الأسماء بالعناوين والعكس. يمكن أن يكون لهذا التنفيذ عواقب دقيقة ولكن مهمة على سلوك أي برنامج Node.js. يرجى تخصيص بعض الوقت لمراجعة قسم اعتبارات التنفيذ قبل استخدام dns.lookup().
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
اسم المضيف | خيط | خطأ شنيع | اسم المضيف المطلوب حله. | |
يختار | هدف | حقيقي | كائن خيارات. | |
opts.family | رقم | خيط | 0 | خطأ شنيع | عائلة السجل. يجب أن يكون 4 أو 6 أو 0. ولأسباب التوافق مع الإصدارات السابقة، يتم تفسير "IPv4" و"IPv6" على أنهما 4 و6 على التوالي. تشير القيمة 0 إلى أنه تم إرجاع عناوين IPv4 وIPv6. الافتراضي: 0. |
سي بي | وظيفة | خطأ شنيع | الوظيفة التي سيتم الاتصال بها بعد اكتمال الطريقة. |
تتيح هذه الوحدة تحليل الاسم. على سبيل المثال، استخدمه للبحث عن عناوين IP لأسماء المضيفين. على الرغم من تسميته باسم نظام اسم المجال (DNS)، إلا أنه لا يستخدم دائمًا بروتوكول DNS لعمليات البحث. يستخدم dns.lookup() مرافق نظام التشغيل لإجراء تحليل الاسم. قد لا يحتاج إلى إجراء أي اتصال بالشبكة. لإجراء تحليل الاسم بنفس الطريقة التي تعمل بها التطبيقات الأخرى على نفس النظام، استخدم dns.lookup().
lookup(hostname, opts)
المستندات الخارجية: https://nodejs.org/api/dns.html#dnspromiseslookuphostname-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
اسم المضيف | خيط | خطأ شنيع | اسم المضيف المطلوب حله. | |
يختار | هدف | حقيقي | كائن خيارات. | |
opts.family | رقم | خيط | 0 | خطأ شنيع | عائلة السجل. يجب أن يكون 4 أو 6 أو 0. ولأسباب التوافق مع الإصدارات السابقة، يتم تفسير "IPv4" و"IPv6" على أنهما 4 و6 على التوالي. تشير القيمة 0 إلى أنه تم إرجاع عناوين IPv4 وIPv6. الافتراضي: 0. |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
تتيح هذه الوحدة التفاعل مع نظام الملفات بطريقة تشبه وظائف POSIX القياسية.
يقيد تطبيق Sandbox الوصول إلى نظام الملفات. يرجى الاطلاع على وثائق وضع الحماية للتطبيق لمزيد من المعلومات: https://sockets.sh/guides/#working-with-the-file-system-on-ios
لاستخدام واجهات برمجة التطبيقات المستندة إلى الوعد:
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;
لاستخدام رد الاتصال وواجهات برمجة التطبيقات غير المتزامنة:
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 | خطأ شنيع | ||
وضع | خيط | F_OK(0) | حقيقي | |
أتصل مرة أخرى | وظيفة (يخطئ، فد) | خطأ شنيع |
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 | حقيقي | |
أتصل مرة أخرى | وظيفة (يخطئ، فد) | خطأ شنيع |
opendir(path, options, callback)
افتح دليلًا بشكل غير متزامن يستدعي callback
عند النجاح أو الخطأ.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.withFileTypes | منطقية | خطأ شنيع | حقيقي | |
أتصل مرة أخرى | وظيفة (يخطئ، فد) | خطأ شنيع |
read(fd, buffer, offset, length, position, callback)
القراءة بشكل غير متزامن من واصف ملف مفتوح.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
فد | رقم | خطأ شنيع | ||
عازلة | كائن | المخزن المؤقت | TypedArray | خطأ شنيع | المخزن المؤقت الذي سيتم كتابة البيانات إليه. | |
إزاحة | رقم | خطأ شنيع | الموضع في المخزن المؤقت لكتابة البيانات إليه. | |
طول | رقم | خطأ شنيع | عدد البايتات المراد قراءتها. | |
موضع | رقم | بيجينت | باطل | خطأ شنيع | يحدد مكان بدء القراءة من الملف. إذا كان الموضع null أو -1، فستتم قراءة البيانات من موضع الملف الحالي، وسيتم تحديث موضع الملف. إذا كان الموضع عددًا صحيحًا، فلن يتغير موضع الملف. | |
أتصل مرة أخرى | وظيفة (يخطئ، بايتسريد، المخزن المؤقت) | خطأ شنيع |
readdir(path, options, callback)
قراءة كافة الإدخالات في الدليل بشكل غير متزامن.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.withFileTypes | منطقية | خطأ شنيع | حقيقي | |
أتصل مرة أخرى | وظيفة (خطأ، المخزن المؤقت) | خطأ شنيع |
readFile(path, options, callback)
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | رقم | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.flag | خيط | ص | حقيقي | |
options.signal | AbortSignal | حقيقي | ||
أتصل مرة أخرى | وظيفة (خطأ، المخزن المؤقت) | خطأ شنيع |
stat(path, options, callback)
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | رقم | خطأ شنيع | اسم الملف أو واصف الملف | |
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.flag | خيط | ص | حقيقي | |
options.signal | AbortSignal | حقيقي | ||
أتصل مرة أخرى | وظيفة (خطأ، البيانات) | خطأ شنيع |
writeFile(path, data, options, callback)
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | رقم | خطأ شنيع | اسم الملف أو واصف الملف | |
بيانات | سلسلة | المخزن المؤقت | المصفوفة المكتوبة | عرض البيانات | هدف | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.mode | خيط | 0o666 | حقيقي | |
options.flag | خيط | ث | حقيقي | |
options.signal | AbortSignal | حقيقي | ||
أتصل مرة أخرى | وظيفة (خطأ) | خطأ شنيع |
writev()
هذا FunctionDeclaration
يُسمى writev
في fs/index.js
، وقد تم تصديره ولكن غير موثق.
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() عندما يكون المسار عبارة عن دليل موجود إلى حدوث خطأ فقط عندما تكون العودية خاطئة. |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | البادئة | عند النجاح، يتم استيفاءه بـ غير محدد إذا كان العودي خطأ، أو مسار الدليل الأول الذي تم إنشاؤه إذا كان العودي صحيحًا. |
open(path, flags, mode)
المستندات الخارجية: https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode
فتح ملف بشكل غير متزامن.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
أعلام | خيط | خطأ شنيع | الافتراضي: "ص" | |
وضع | خيط | خطأ شنيع | الافتراضي: 0o666 |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
opendir(path, options)
المستندات الخارجية: https://nodejs.org/api/fs.html#fspromisesopendirpath-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.bufferSize | رقم | 32 | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | وعد<نظام الملفات،دير> |
readdir(path, options)
المستندات الخارجية: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreaddirpath-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | خيط | utf8 | حقيقي | |
options.withFileTypes | منطقية | خطأ شنيع | حقيقي |
readFile(path, options)
المستندات الخارجية: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromisesreadfilepath-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | خيط | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | سلسلة | باطل | باطل | حقيقي | |
options.flag | خيط | ص | حقيقي | |
options.signal | AbortSignal | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | وعد <المخزن المؤقت | سلسلة> |
stat(path, options)
المستندات الخارجية: https://nodejs.org/api/fs.html#fspromisesstatpath-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.bigint | منطقية | خطأ شنيع | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
writeFile(path, data, options)
المستندات الخارجية: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fspromiseswritefilefile-data-options
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
طريق | سلسلة | المخزن المؤقت | عنوان URL | FileHandle | خطأ شنيع | اسم الملف أو FileHandle | |
بيانات | سلسلة | المخزن المؤقت | صفيف | عرض البيانات | المصفوفة المكتوبة | تدفق | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.encoding | سلسلة | باطل | utf8 | خطأ شنيع | |
options.mode | رقم | 0o666 | خطأ شنيع | |
options.flag | خيط | ث | خطأ شنيع | |
options.signal | AbortSignal | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
هذا 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
في المنشئ.
هذا عبارة عن VariableDeclaration
المسمى FileReadStream
في fs/stream.js
، وقد تم تصديره ولكن غير موثق.
هذا عبارة عن VariableDeclaration
المسمى FileWriteStream
في fs/stream.js
، وقد تم تصديره ولكن غير موثق.
هذه واجهة برمجة التطبيقات (API) ذات المستوى المنخفض والتي لا تحتاج إليها إلا إذا كنت تقوم بتنفيذ مكتبة أعلى المقبس SDK. يحتوي تطبيق مقبس SDK على عمليتين أو ثلاث عمليات.
Render
، واجهة المستخدم حيث يتم تشغيل HTML وCSS وJS.Bridge
، الطبقة الرقيقة من التعليمات البرمجية التي تدير كل شيء.Main
، للتطبيقات التي تحتاج إلى تشغيل مهام حوسبة أثقل. وعلى عكس الإلكترون فهو اختياري.تدير عملية Bridge عمليتي Render وMain، ويمكنها أيضًا وسيط البيانات بينهما.
تستخدم عملية الربط الإدخال والإخراج القياسي كوسيلة للتواصل. يتم تخزين البيانات المكتوبة في نهاية الكتابة للأنبوب مؤقتًا بواسطة نظام التشغيل حتى تتم قراءتها من نهاية القراءة للأنبوب.
يستخدم بروتوكول IPC مخططًا بسيطًا يشبه URI. يتم تمرير البيانات كـ ArrayBuffers.
ipc://command?key1=value1&key2=value2...
postMessage()
هذا FunctionDeclaration
يُسمى postMessage
في ipc.js
، وقد تم تصديره ولكن غير موثق.
يمثل حالة IPC جيدة.
يمثل حالة خطأ IPC.
المهلة بالمللي ثانية لطلبات IPC.
رمز الخاصية ipc.debug.enabled
parseSeq(seq, options)
يوزع seq
كقيمة عددية
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
تسلسل | سلسلة | رقم | خطأ شنيع | ||
خيارات | هدف | حقيقي | ||
options.bigint | منطقية | خطأ شنيع | خطأ شنيع |
debug(enable)
إذا كان debug.enabled === true
، فستتم طباعة مخرجات تصحيح الأخطاء على وحدة التحكم.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يُمكَِن | منطقية | خطأ شنيع |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | منطقية |
Message
(يمتد URL
) حاوية لرسالة IPC بناءً على نظام ipc://
URI.
PROTOCOL()
البروتوكول المتوقع لرسالة IPC.
from(input, params)
ينشئ مثيل Message
من مجموعة متنوعة من المدخلات.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
مدخل | سلسلة | عنوان URL | رسالة | المخزن المؤقت | هدف | خطأ شنيع | ||
المعلمات | كائن | سلسلة | URLSearchParams | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | رسالة |
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
.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
مفتاح | خيط | خطأ شنيع | ||
defaultValue | مختلط | خطأ شنيع |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | مختلط |
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
.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
اسم | خيط | خطأ شنيع | ||
قيمة | مختلط | خطأ شنيع | ||
هدف | EventTarget | نافذة | حقيقي | |
خيارات | هدف | حقيقي |
resolve(seq, value)
يحل الطلب seq
مع القيمة المحتملة.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
تسلسل | خيط | خطأ شنيع | ||
قيمة | مختلط | خطأ شنيع |
send(command, value)
يرسل طلب أمر IPC غير متزامن مع المعلمات.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يأمر | خيط | خطأ شنيع | ||
قيمة | مختلط | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
write(command, params, buffer, options)
يرسل طلب أمر IPC غير متزامن مع المعلمات والبايتات المخزنة مؤقتًا.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يأمر | خيط | خطأ شنيع | ||
المعلمات | هدف | حقيقي | ||
عازلة | المخزن المؤقت | نوع الصفيف | صفيفالمخزن المؤقت | سلسلة | صفيف | حقيقي | ||
خيارات | هدف | حقيقي |
request(command, params, options)
يرسل طلب أمر IPC غير متزامن مع معلمات تطلب استجابة بالبايتات المخزنة مؤقتًا.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يأمر | خيط | خطأ شنيع | ||
المعلمات | هدف | حقيقي | ||
خيارات | هدف | حقيقي |
createBinding(domain, ctx)
مصنع لإنشاء واجهة برمجة تطبيقات IPC المستندة إلى الوكيل.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
اِختِصاص | خيط | خطأ شنيع | ||
ctx | وظيفة | هدف | حقيقي | ||
ctx.default | خيط | حقيقي |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | الوكيل |
توفر هذه الوحدة معلومات النظام المقيسة من جميع أنظمة التشغيل الرئيسية.
arch()
هذا FunctionDeclaration
يُسمى arch
في os.js
، وقد تم تصديره ولكن غير موثق.
networkInterfaces()
هذا إعلان FunctionDeclaration
يُسمى networkInterfaces
في os.js
، وقد تم تصديره ولكن غير موثق.
platform()
هذا هو platform
المسمى FunctionDeclaration
في os.js
، وقد تم تصديره ولكن غير موثق.
type()
هذا هو type
مسمى FunctionDeclaration
في os.js
، وقد تم تصديره ولكن غير موثق.
isWindows()
هذا FunctionDeclaration
يُسمى isWindows
في os.js
، وقد تم تصديره ولكن غير موثق.
tmpdir()
هذا FunctionDeclaration
يُسمى tmpdir
في os.js
، وقد تم تصديره ولكن غير موثق.
هذا عبارة عن VariableDeclaration
المسمى EOL
في os.js
، وقد تم تصديره ولكن غير موثق.
هذا هو ClassDeclaration
المسمى Path
in path/path.js
، وقد تم تصديره ولكن غير موثق.
cwd(opts)
يحسب دليل العمل الحالي للمسار
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يختار | هدف | حقيقي | ||
opts.posix اضبط على true لفرض مسار نمط POSIX | منطقية | حقيقي |
constructor(opts)
منشئ فئة Path
.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
يختار | هدف | حقيقي | ||
opts.root | خيط | حقيقي | ||
opts.base | خيط | حقيقي | ||
opts.name | خيط | حقيقي | ||
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
in 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.window | رقم | window.currentWindow | خطأ شنيع | مؤشر النافذة |
opts.url | رقم | خطأ شنيع | المسار إلى ملف HTML للتحميل في النافذة |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | وعد<ipc.Result> |
setWindowBackgroundColor()
هذا FunctionDeclaration
يُسمى setWindowBackgroundColor
في runtime.js
، وقد تم تصديره ولكن غير موثق.
setContextMenu(options)
يفتح قائمة السياق الأصلية.
دعوى | يكتب | تقصير | خياري | وصف |
---|---|---|---|---|
خيارات | هدف | خطأ شنيع | كائن الخيارات |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
setSystemMenuItemEnabled()
هذا هو FunctionDeclaration
المسمى setSystemMenuItemEnabled
في runtime.js
، وقد تم تصديره ولكن غير موثق.
setSystemMenu(options)
قم بتعيين القائمة الأصلية للتطبيق.
يوفر وقت تشغيل المقبس خدمة DSL بسيطة تجعل من السهل إنشاء نظام أصلي وقوائم سياقية عبر الأنظمة الأساسية.
يتم إنشاء القوائم في وقت التشغيل. يمكن إنشاؤها من خلال العملية الرئيسية أو عملية التقديم. يمكن إعادة إنشائها على الفور عن طريق استدعاء الأسلوب setSystemMenu
.
الطريقة تأخذ سلسلة. وهنا مثال على القائمة. تشير الفاصلة المنقوطة إلى نهاية القائمة. استخدم الشرطة السفلية عندما لا يكون هناك مفتاح تسريع. المعدلات اختيارية. وستحصل خيارات قائمة نظام التشغيل المعروفة، مثل قائمة التعديل، تلقائيًا على مسرّعات لا تحتاج إلى تحديدها.
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;
` )
لإنشاء فاصل، استخدم ثلاث شرطات ---
.
تُستخدم معدّلات التسريع كمؤشرات مرئية ولكن ليس لها تأثير مادي حيث يتم ربط المفتاح الفعلي في مستمع الحدث.
يشير الحرف الكبير إلى أنه تم تعديل دواسة السرعة بواسطة مفتاح 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 | خيط | خطأ شنيع | تخطيط القائمة | |
options.index | رقم | خطأ شنيع | النافذة المستهدفة (إن أمكن) |
قيمة الإرجاع | يكتب | وصف |
---|---|---|
غير محدد | يعد |
reload()
هذا هو FunctionDeclaration
يُسمى reload
في runtime.js
، وقد تم تصديره ولكن غير موثق.