Высокоуровневый кроссплатформенный API для Bluetooth Pub-Sub.
Bluetooth
(расширяет EventEmitter
)Создайте экземпляр службы Bluetooth.
constructor(serviceId)
Конструктор — пример свойства, которому присвоено true
Создает новую службу с парами ключ-значение.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
идентификатор службы | нить | ЛОЖЬ | Учитывая значение по умолчанию для определения типа |
start()
Запустите службу Bluetooth.
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещание<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,coding), но выдает ошибку TypeError, если значение является числом. Buffer.from(str[,coding]) Buffer.from(массив) Buffer.from(буфер) Buffer.from(arrayBuffer[, byteOffset[, length]])
Функционально эквивалентен Buffer(arg,coding), но выдает ошибку TypeError, если значение является числом. Buffer.from(str[,coding]) Buffer.from(массив) Buffer.from(буфер) Buffer.from(arrayBuffer[, byteOffset[, length]])
Функционально эквивалентен Buffer(arg,coding), но выдает ошибку TypeError, если значение является числом. Buffer.from(str[,coding]) Buffer.from(массив) Buffer.from(буфер) Buffer.from(arrayBuffer[, byteOffset[, length]])
Функционально эквивалентен Buffer(arg,coding), но выдает ошибку TypeError, если значение является числом. Buffer.from(str[,coding]) Buffer.from(массив) Buffer.from(буфер) Buffer.from(arrayBuffer[, byteOffset[, length]])
Создает новый заполненный экземпляр Buffer. alloc(размер[, заливка[, кодировка]])
Создает новый заполненный экземпляр Buffer. alloc(размер[, заливка[, кодировка]])
Создает новый заполненный экземпляр Buffer. alloc(размер[, заливка[, кодировка]])
Создает новый заполненный экземпляр Buffer. alloc(размер[, заливка[, кодировка]])
Эквивалент Buffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент Buffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент Buffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент Buffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент SlowBuffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент SlowBuffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент SlowBuffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Эквивалент SlowBuffer(num), по умолчанию создает экземпляр Buffer, не заполненный нулями.
Некоторые высокоуровневые методы API crypto.subtle
для получения случайных байтов и хеширования.
ВебКрипто API
getRandomValues(buffer)
Внешняя документация: https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues.
Генерация криптостойких случайных значений в buffer
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
буфер | Типизированный массив | ЛОЖЬ |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Типизированный массив |
Максимальный общий размер случайных байтов на странице
Максимальный общий размер случайных байтов.
Максимальный общий объем выделенных на страницу байтов (макс./квота)
randomBytes(size)
Генерация случайных байтов size
.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
размер | число | ЛОЖЬ | Количество байтов, которые нужно сгенерировать. Размер не должен быть больше 2**31 – 1. |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Буфер | Обещание, которое разрешается с помощью экземпляра socket.Buffer со случайными байтами. |
createDigest(algorithm, message)
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
алгоритм | нить | ЛОЖЬ | SHA-1 | |
сообщение | Буфер | Типизированныймассив | Просмотр данных | ЛОЖЬ | Экземпляр Socket.Buffer, TypedArray или Dataview. |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещать | Обещание, которое разрешается с помощью экземпляра socket.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»), либо объект параметров. | |
параметры.тип | нить | истинный | Семейство розеток. Должно быть либо «udp4», либо «udp6». Необходимый. | |
options.reuseAddr | логическое значение | ЛОЖЬ | истинный | Когда true, socket.bind() будет повторно использовать адрес, даже если другой процесс уже привязал к нему сокет. По умолчанию: ложь. |
options.ipv6Only | логическое значение | ЛОЖЬ | истинный | Установка для ipv6Only значения true отключит поддержку двойного стека, т. е. привязка к адресу :: не приведет к привязке 0.0.0.0. По умолчанию: ложь. |
options.recvBufferSize | число | истинный | Устанавливает значение сокета SO_RCVBUF. | |
options.sendBufferSize | число | истинный | Устанавливает значение сокета SO_SNDBUF. | |
options.signal | Прервать сигнал | истинный | AbortSignal, который можно использовать для закрытия сокета. | |
перезвонить | функция | истинный | Прикреплен в качестве прослушивателя событий «сообщения». Необязательный. |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Розетка |
Socket
(расширяет EventEmitter
)Новые экземпляры dgram.Socket создаются с помощью dgram.createSocket(). Ключевое слово new не следует использовать для создания экземпляров 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). После завершения соединения генерируется событие «connect» и вызывается дополнительная функция обратного вызова. В случае сбоя вызывается обратный вызов или, в противном случае, генерируется событие «ошибка».
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
порт | число | ЛОЖЬ | Порт, к которому должен подключиться клиент. | |
хозяин | нить | истинный | Хост, к которому должен подключиться клиент. | |
ConnectListener | функция | истинный | Общий параметр методов 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.
Единственный способ узнать наверняка, что дейтаграмма отправлена, — это использовать обратный вызов. Если возникает ошибка и задан обратный вызов, ошибка будет передана в качестве первого аргумента обратного вызова. Если обратный вызов не задан, ошибка генерируется как событие «ошибка» в объекте сокета.
Смещение и длина не являются обязательными, но оба должны быть установлены, если они используются. Они поддерживаются только в том случае, если первым аргументом является Buffer, TypedArray или DataView.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
сообщение | Буфер | Типизированныймассив | Просмотр данных | строка | Множество | ЛОЖЬ | Сообщение для отправки. | |
компенсировать | целое число | истинный | Смещение в буфере, где начинается сообщение. | |
длина | целое число | истинный | Количество байтов в сообщении. | |
порт | целое число | истинный | Порт назначения. | |
адрес | нить | истинный | Имя хоста назначения или IP-адрес. | |
перезвонить | Функция | истинный | Вызывается при отправке сообщения. |
close(callback)
Внешняя документация: https://nodejs.org/api/dgram.html#socketclosecallback.
Закройте базовый сокет и прекратите прослушивание данных в нем. Если предусмотрен обратный вызов, он добавляется в качестве прослушивателя события закрытия.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
перезвонить | функция | истинный | Вызывается, когда соединение завершено или в случае ошибки. |
address()
Внешние документы: https://nodejs.org/api/dgram.html#socketaddress.
Возвращает объект, содержащий информацию об адресе сокета. Для сокетов UDP этот объект будет содержать свойства адреса, семейства и порта.
Этот метод генерирует EBADF, если вызывается для несвязанного сокета.
Возвращаемое значение | Тип | Описание |
---|---|---|
сокетинформация | Объект | Информация о локальном сокете |
сокетИнфо.адрес | нить | IP-адрес сокета |
сокетИнфо.порт | нить | Порт сокета |
SocketInfo.family | нить | Семейство IP сокета |
remoteAddress()
Внешние документы: https://nodejs.org/api/dgram.html#socketremoteaddress.
Возвращает объект, содержащий адрес, семейство и порт удаленной конечной точки. Этот метод генерирует исключение ERR_SOCKET_DGRAM_NOT_CONNECTED, если сокет не подключен.
Возвращаемое значение | Тип | Описание |
---|---|---|
сокетинформация | Объект | Информация об удаленном сокете |
сокетИнфо.адрес | нить | IP-адрес сокета |
сокетИнфо.порт | нить | Порт сокета |
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 в байтах. |
Этот модуль обеспечивает разрешение имен. Например, используйте его для поиска 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). Все свойства опции являются необязательными. Если options — целое число, оно должно быть 4 или 6 — если options равно 0 или не указано, то возвращаются адреса IPv4 и IPv6, если они найдены.
С сайта node.js...
Если для параметра all установлено значение true, аргументы обратного вызова изменяются на (ошибка, адреса), при этом адреса представляют собой массив объектов со свойствами адрес и семейство.
В случае ошибки 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. |
КБ | функция | ЛОЖЬ | Функция, вызываемая после завершения метода. |
Этот модуль обеспечивает разрешение имен. Например, используйте его для поиска 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.
Песочница приложения ограничивает доступ к файловой системе. Дополнительную информацию см. в документации по песочнице приложения: https://sockets.sh/guides/#working-with-the-file-system-on-ios.
Чтобы использовать API на основе обещаний:
import * as fs from '@socketsupply/socket-api/fs/promises.js' ;
Чтобы использовать 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) | истинный | |
перезвонить | функция (ошибка, ФД) | ЛОЖЬ |
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-адрес | ЛОЖЬ | ||
параметры | объект | истинный |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | фс.ReadStream |
createWriteStream(path, options)
Внешние документы: https://nodejs.org/dist/latest-v16.x/docs/api/fs.html#fscreatewritestreampath-options.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | ЛОЖЬ | ||
параметры | объект | истинный |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | фс.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-адрес | ЛОЖЬ | ||
флаги | нить | р | истинный | |
режим | нить | 0о666 | истинный | |
перезвонить | функция (ошибка, ФД) | ЛОЖЬ |
opendir(path, options, callback)
Асинхронно открывайте каталог, вызывая callback
в случае успеха или ошибки.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | ЛОЖЬ | ||
параметры | Объект | истинный | ||
options.encoding | нить | utf8 | истинный | |
options.withFileTypes | логическое значение | ЛОЖЬ | истинный | |
перезвонить | функция (ошибка, ФД) | ЛОЖЬ |
read(fd, buffer, offset, length, position, callback)
Асинхронное чтение из дескриптора открытого файла.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
ФД | число | ЛОЖЬ | ||
буфер | объект | Буфер | Типизированный массив | ЛОЖЬ | Буфер, в который будут записаны данные. | |
компенсировать | число | ЛОЖЬ | Позиция в буфере, в которую будут записываться данные. | |
длина | число | ЛОЖЬ | Количество байтов для чтения. | |
позиция | номер | БигИнт | нулевой | ЛОЖЬ | Указывает, с чего начать чтение в файле. Если позиция равна нулю или -1, данные будут считываться из текущей позиции файла, и позиция файла будет обновлена. Если позиция является целым числом, позиция файла не изменится. | |
перезвонить | функция (ошибка, bytesRead, буфер) | ЛОЖЬ |
readdir(path, options, callback)
Асинхронно читать все записи в каталоге.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | ЛОЖЬ | ||
параметры | объект | истинный | ||
options.encoding | нить | utf8 | истинный | |
options.withFileTypes | логическое значение | ЛОЖЬ | истинный | |
перезвонить | функция (ошибка, буфер) | ЛОЖЬ |
readFile(path, options, callback)
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | число | ЛОЖЬ | ||
параметры | объект | истинный | ||
options.encoding | нить | utf8 | истинный | |
options.flag | нить | р | истинный | |
options.signal | Прервать сигнал | истинный | ||
перезвонить | функция (ошибка, буфер) | ЛОЖЬ |
stat(path, options, callback)
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | число | ЛОЖЬ | имя файла или файловый дескриптор | |
параметры | объект | истинный | ||
options.encoding | нить | utf8 | истинный | |
options.flag | нить | р | истинный | |
options.signal | Прервать сигнал | истинный | ||
перезвонить | функция (ошибка, данные) | ЛОЖЬ |
writeFile(path, data, options, callback)
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
путь | строка | Буфер | URL-адрес | число | ЛОЖЬ | имя файла или файловый дескриптор | |
данные | строка | Буфер | Типизированныймассив | Просмотр данных | объект | ЛОЖЬ | ||
параметры | объект | истинный | ||
options.encoding | нить | utf8 | истинный | |
options.mode | нить | 0о666 | истинный | |
options.flag | нить | ш | истинный | |
options.signal | Прервать сигнал | истинный | ||
перезвонить | функция (ошибка) | ЛОЖЬ |
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(), когда путь представляет собой существующий каталог, приводит к ошибке только в том случае, если рекурсивный параметр имеет значение false. |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Примайс | В случае успеха выполняется с неопределенным значением, если рекурсивное значение равно false, или с первым созданным путем к каталогу, если рекурсивное значение равно true. |
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 | Прервать сигнал | истинный |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещание<Буфер | строка> |
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 | |
данные | строка | Буфер | Массив | Просмотр данных | Типизированныймассив | Транслировать | ЛОЖЬ | ||
параметры | объект | истинный | ||
options.encoding | строка | нулевой | utf8 | ЛОЖЬ | |
options.mode | число | 0о666 | ЛОЖЬ | |
options.flag | нить | ш | ЛОЖЬ | |
options.signal | Прервать сигнал | истинный |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещать |
Это объявление VariableDeclaration
с именем DEFAULT_STREAM_HIGH_WATER_MARK
в fs/stream.js
, оно экспортировано, но недокументировано.
ReadStream
(расширяет Readable
) Readable
поток для FileHandle
.
constructor()
Конструктор класса ReadStream
setHandle(handle)
Устанавливает дескриптор файла для ReadStream.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
ручка | дескриптор файла | ЛОЖЬ |
highWaterMark()
Максимальный размер буфера для ReadStream.
path()
Относительный или абсолютный путь к базовому FileHandle
.
pending()
true
если поток находится в состоянии ожидания.
emit()
Обрабатывает параметр shouldEmitClose
из options.emitClose
в конструкторе.
WriteStream
(расширяет Writable
) Writable
поток для FileHandle
.
constructor()
Конструктор класса WriteStream
setHandle(handle)
Устанавливает дескриптор файла для WriteStream.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
ручка | дескриптор файла | ЛОЖЬ |
highWaterMark()
Максимальный размер буфера для Writetream.
path()
Относительный или абсолютный путь к базовому FileHandle
.
pending()
true
если поток находится в состоянии ожидания.
emit()
Обрабатывает параметр shouldEmitClose
из options.emitClose
в конструкторе.
Это объявление VariableDeclaration
с именем FileReadStream
в fs/stream.js
, оно экспортировано, но недокументировано.
Это VariableDeclaration
с именем FileWriteStream
в fs/stream.js
, оно экспортировано, но недокументировано.
Это низкоуровневый API, который вам не понадобится, если вы не реализуете библиотеку поверх Socket SDK. Приложение Socket SDK имеет два или три процесса.
Render
— пользовательский интерфейс, в котором запускаются HTML, CSS и JS.Bridge
— тонкий слой кода, который управляет всем.Main
процесс для приложений, которым необходимо выполнять более тяжелые вычислительные задания. И в отличие от электрона это необязательно.Процесс Bridge управляет процессами Render и Main, а также может служить посредником между ними.
Процесс привязки использует стандартный ввод и вывод как способ взаимодействия. Данные, записанные на конец канала записи, буферизуются операционной системой до тех пор, пока они не будут прочитаны из конца канала чтения.
Протокол IPC использует простую схему, подобную URI. Данные передаются как ArrayBuffers.
ipc://command?key1=value1&key2=value2...
postMessage()
Это FunctionDeclaration
с именем postMessage
в ipc.js
, оно экспортировано, но недокументировано.
Представляет состояние OK IPC.
Представляет состояние ОШИБКА IPC.
Таймаут в миллисекундах для запросов IPC.
Символ свойства ipc.debug.enabled
parseSeq(seq, options)
Анализирует seq
как целочисленное значение
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
последовательность | строка | число | ЛОЖЬ | ||
параметры | объект | истинный | ||
options.bigint | логическое значение | ЛОЖЬ | ЛОЖЬ |
debug(enable)
Если debug.enabled === true
, выходные данные отладки будут выведены на консоль.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
давать возможность | логическое значение | ЛОЖЬ |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | логическое значение |
Message
(расширяет URL
) Контейнер для сообщения IPC, основанный на схеме URI ipc://
.
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
.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
ключ | нить | ЛОЖЬ | ||
значение по умолчанию | смешанный | ЛОЖЬ |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | смешанный |
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)
Событие Emit, которое будет отправлено на объект window
.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
имя | нить | ЛОЖЬ | ||
ценить | Смешанный | ЛОЖЬ | ||
цель | EventTarget | окно | истинный | |
параметры | Объект | истинный |
resolve(seq, value)
Разрешает запрос по seq
с возможным значением.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
последовательность | нить | ЛОЖЬ | ||
ценить | Смешанный | ЛОЖЬ |
send(command, value)
Отправляет запрос асинхронной команды IPC с параметрами.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
команда | нить | ЛОЖЬ | ||
ценить | Смешанный | истинный |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещать |
write(command, params, buffer, options)
Отправляет запрос асинхронной команды IPC с параметрами и буферизованными байтами.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
команда | нить | ЛОЖЬ | ||
параметры | объект | истинный | ||
буфер | Буфер | Типмассив | МассивБуфер | строка | Множество | истинный | ||
параметры | объект | истинный |
request(command, params, options)
Отправляет запрос асинхронной команды IPC с параметрами, запрашивающими ответ с буферизованными байтами.
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
команда | нить | ЛОЖЬ | ||
параметры | объект | истинный | ||
параметры | объект | истинный |
createBinding(domain, ctx)
Фабрика для создания API 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
в 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
в 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, который позволяет легко создавать кроссплатформенную систему и контекстные меню.
Меню создаются во время выполнения. Они могут быть созданы в процессе Main или Render. Их можно мгновенно воссоздать, вызвав метод 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
во внешнем коде, после чего вы можете взаимодействовать со своим внутренним кодом, если хотите.
Например, если в меню Other
выбран пункт Apple
…
window . addEventListener ( 'menuItemSelected' , event => {
assert ( event . detail . parent === 'Other' )
assert ( event . detail . title === 'Apple' )
} )
Аргумент | Тип | По умолчанию | Необязательный | Описание |
---|---|---|---|---|
параметры | объект | ЛОЖЬ | объект опций | |
options.value | нить | ЛОЖЬ | макет меню | |
options.index | число | ЛОЖЬ | целевое окно (если применимо) |
Возвращаемое значение | Тип | Описание |
---|---|---|
Не указан | Обещать |
reload()
Это FunctionDeclaration
с именем reload
в runtime.js
, оно экспортировано, но недокументировано.