Espruino:Справочник по API/Класс Serial/pipe(): различия между версиями

Материал из Онлайн справочника
Перейти к навигацииПерейти к поиску
Нет описания правки
Нет описания правки
Строка 3: Строка 3:
{{Myagkij-редактор}}
{{Myagkij-редактор}}


=<ref>[https://www.espruino.com/Reference#l_Serial_pipe www.espruino.com - function Serial.pipe(destination, options)]</ref>=
=Функция Serial.pipe()<ref>[https://www.espruino.com/Reference#l_Serial_pipe www.espruino.com - function Serial.pipe(destination, options)]</ref>=


==Синтаксис==
==Синтаксис==


<syntaxhighlight lang="javascript" enclose="div">
<syntaxhighlight lang="javascript" enclose="div">
 
Serial.pipe(destination, options)
</syntaxhighlight>
</syntaxhighlight>


==Параметры==
==Параметры==


 
* '''destination''' – файл/поток-получатель, получающий данные от источника
* '''options''' – опциональный объект с настройками в формате { chunkSize : int=32, end : bool=true, complete : function }:
** '''chunkSize''' – количество данных, передаваемых от source к destination за раз
** '''complete''' – функция, вызываемая после завершения передачи данных
** '''end''' – здесь задается, вызывать ли на получателе end-функцию после того, как исходный файл/поток завершит передачу данных, или нет


==Возвращаемое значение==
==Возвращаемое значение==
Строка 21: Строка 25:
==Описание==
==Описание==


Передает данные текущего USART-порта в поток (объект с методом write()).


'''Примечание:''' Эта функция не доступна для устройств с маленькой flash-памятью.


== Примеры ==
== Примеры ==


 
Эта функция используется в следующих статьях документации [[Espruino]]:
* [https://www.espruino.com/Programming#line=4 Способы программирования Espruino]


=См.также=
=См.также=

Версия от 21:37, 25 февраля 2021

Перевод: Максим Кузьмин
Проверка/Оформление/Редактирование: Мякишев Е.А.


Функция Serial.pipe()[1]

Синтаксис

Serial.pipe(destination, options)

Параметры

  • destination – файл/поток-получатель, получающий данные от источника
  • options – опциональный объект с настройками в формате { chunkSize : int=32, end : bool=true, complete : function }:
    • chunkSize – количество данных, передаваемых от source к destination за раз
    • complete – функция, вызываемая после завершения передачи данных
    • end – здесь задается, вызывать ли на получателе end-функцию после того, как исходный файл/поток завершит передачу данных, или нет

Возвращаемое значение

Описание

Передает данные текущего USART-порта в поток (объект с методом write()).

Примечание: Эта функция не доступна для устройств с маленькой flash-памятью.

Примеры

Эта функция используется в следующих статьях документации Espruino:

См.также

Внешние ссылки