2020-02-11 00:08:19 +09:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2021-07-24 15:12:56 +00:00
< title > GPIO | megabit< / title >
< meta name = "description" content = "Documentation for megabit" >
2020-02-11 00:08:19 +09:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
2021-07-24 15:12:56 +00:00
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
2020-02-11 00:08:19 +09:00
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
2021-07-24 15:12:56 +00:00
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
2020-02-11 00:08:19 +09:00
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > megabit< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
2021-07-24 15:12:56 +00:00
< a href = "../modules.html" > megabit< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li >
2021-07-24 15:12:56 +00:00
< a href = "../modules/gpio.html" > gpio< / a >
< / li >
< li >
< a href = "gpio.GPIO.html" > GPIO< / a >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h1 > Class GPIO< / h1 >
2020-02-11 00:08:19 +09:00
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
2021-07-24 15:12:56 +00:00
< span class = "tsd-signature-type" > GPIOPort< / span >
2020-02-11 00:08:19 +09:00
< ul class = "tsd-hierarchy" >
< li >
2021-07-24 15:12:56 +00:00
< span class = "target" > GPIO< / span >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
2021-07-24 15:12:56 +00:00
< section class = "tsd-index-section tsd-is-inherited" >
2020-02-11 00:08:19 +09:00
< h3 > Constructors< / h3 >
< ul class = "tsd-index-list" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < a href = "gpio.GPIO.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-index-section tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#onchange" class = "tsd-kind-icon" > onchange< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#captureRejectionSymbol" class = "tsd-kind-icon" > capture< wbr > Rejection< wbr > Symbol< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#captureRejections" class = "tsd-kind-icon" > capture< wbr > Rejections< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#defaultMaxListeners" class = "tsd-kind-icon" > default< wbr > Max< wbr > Listeners< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#errorMonitor" class = "tsd-kind-icon" > error< wbr > Monitor< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / section >
< section class = "tsd-index-section tsd-is-external" >
< h3 > Accessors< / h3 >
< ul class = "tsd-index-list" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" > < a href = "gpio.GPIO.html#direction" class = "tsd-kind-icon" > direction< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" > < a href = "gpio.GPIO.html#exported" class = "tsd-kind-icon" > exported< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" > < a href = "gpio.GPIO.html#pinName" class = "tsd-kind-icon" > pin< wbr > Name< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" > < a href = "gpio.GPIO.html#portName" class = "tsd-kind-icon" > port< wbr > Name< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" > < a href = "gpio.GPIO.html#portNumber" class = "tsd-kind-icon" > port< wbr > Number< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-index-section " >
2020-02-11 00:08:19 +09:00
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#addListener" class = "tsd-kind-icon" > add< wbr > Listener< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#emit" class = "tsd-kind-icon" > emit< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#eventNames" class = "tsd-kind-icon" > event< wbr > Names< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#export" class = "tsd-kind-icon" > export< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#getMaxListeners" class = "tsd-kind-icon" > get< wbr > Max< wbr > Listeners< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#listenerCount" class = "tsd-kind-icon" > listener< wbr > Count< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#listeners" class = "tsd-kind-icon" > listeners< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#off" class = "tsd-kind-icon" > off< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#on" class = "tsd-kind-icon" > on< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#once" class = "tsd-kind-icon" > once< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#prependListener" class = "tsd-kind-icon" > prepend< wbr > Listener< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#prependOnceListener" class = "tsd-kind-icon" > prepend< wbr > Once< wbr > Listener< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#rawListeners" class = "tsd-kind-icon" > raw< wbr > Listeners< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" > < a href = "gpio.GPIO.html#read" class = "tsd-kind-icon" > read< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#removeAllListeners" class = "tsd-kind-icon" > remove< wbr > All< wbr > Listeners< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#removeListener" class = "tsd-kind-icon" > remove< wbr > Listener< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#setMaxListeners" class = "tsd-kind-icon" > set< wbr > Max< wbr > Listeners< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" > < a href = "gpio.GPIO.html#unexport" class = "tsd-kind-icon" > unexport< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" > < a href = "gpio.GPIO.html#write" class = "tsd-kind-icon" > write< / a > < / li >
2021-09-04 04:29:30 +00:00
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#getEventListeners" class = "tsd-kind-icon" > get< wbr > Event< wbr > Listeners< / a > < / li >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#listenerCount-1" class = "tsd-kind-icon" > listener< wbr > Count< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#on-1" class = "tsd-kind-icon" > on< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" > < a href = "gpio.GPIO.html#once-1" class = "tsd-kind-icon" > once< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / section >
< / div >
< / section >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel-group tsd-member-group tsd-is-inherited" >
2020-02-11 00:08:19 +09:00
< h2 > Constructors< / h2 >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" >
2020-02-11 00:08:19 +09:00
< a name = "constructor" class = "tsd-anchor" > < / a >
< h3 > constructor< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" >
< li class = "tsd-signature tsd-kind-icon" > new GPIO< span class = "tsd-signature-symbol" > (< / span > portNumber< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.constructor< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:39< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-07-24 15:12:56 +00:00
< h5 > portNumber: < span class = "tsd-signature-type" > number< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< h2 > Properties< / h2 >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "onchange" class = "tsd-anchor" > < / a >
< h3 > onchange< / h3 >
< div class = "tsd-signature tsd-kind-icon" > onchange< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > GPIOChangeEventHandler< / span > < / div >
2020-02-11 00:08:19 +09:00
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.onchange< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:38< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "captureRejectionSymbol" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > capture< wbr > Rejection< wbr > Symbol< / h3 >
< div class = "tsd-signature tsd-kind-icon" > capture< wbr > Rejection< wbr > Symbol< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > typeof < / span > < a href = "gpio.GPIO.html#captureRejectionSymbol" class = "tsd-signature-type" data-tsd-kind = "Property" > captureRejectionSymbol< / a > < / div >
2020-02-11 00:08:19 +09:00
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.captureRejectionSymbol< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:273< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "captureRejections" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > capture< wbr > Rejections< / h3 >
< div class = "tsd-signature tsd-kind-icon" > capture< wbr > Rejections< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
2020-02-11 00:08:19 +09:00
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.captureRejections< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:278< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Sets or gets the default captureRejection value for all emitters.< / p >
< / div >
< / div >
2020-02-11 00:08:19 +09:00
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "defaultMaxListeners" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > default< wbr > Max< wbr > Listeners< / h3 >
< div class = "tsd-signature tsd-kind-icon" > default< wbr > Max< wbr > Listeners< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
2020-02-11 00:08:19 +09:00
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.defaultMaxListeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:279< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a name = "errorMonitor" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > error< wbr > Monitor< / h3 >
< div class = "tsd-signature tsd-kind-icon" > error< wbr > Monitor< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > typeof < / span > < a href = "gpio.GPIO.html#errorMonitor" class = "tsd-signature-type" data-tsd-kind = "Property" > errorMonitor< / a > < / div >
2020-02-11 00:08:19 +09:00
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.errorMonitor< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:272< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > This symbol shall be used to install a listener for only monitoring < code > ' error' < / code >
events. Listeners installed using this symbol are called before the regular
< code > ' error' < / code > listeners are called.< / p >
< / div >
< p > Installing a listener using this symbol does not change the behavior once an
< code > ' error' < / code > event is emitted, therefore the process will still crash if no
regular < code > ' error' < / code > listener is installed.< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group tsd-is-external" >
< h2 > Accessors< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
< a name = "direction" class = "tsd-anchor" > < / a >
< h3 > direction< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > direction< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > DirectionMode< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:43< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > DirectionMode< / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
< a name = "exported" class = "tsd-anchor" > < / a >
< h3 > exported< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > exported< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:44< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a name = "pinName" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > pin< wbr > Name< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > pinName< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:42< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a name = "portName" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > port< wbr > Name< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > portName< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:41< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a name = "portNumber" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > port< wbr > Number< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > portNumber< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:40< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel-group tsd-member-group " >
2020-02-11 00:08:19 +09:00
< h2 > Methods< / h2 >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "addListener" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > add< wbr > Listener< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > add< wbr > Listener< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.addListener< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:299< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Alias for < code > emitter.on(eventName, listener)< / code > .< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.26< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "emit" class = "tsd-anchor" > < / a >
< h3 > emit< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > emit< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.emit< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:555< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Synchronously calls each of the listeners registered for the event named< code > eventName< / code > , in the order they were registered, passing the supplied arguments
to each.< / p >
< / div >
< p > Returns < code > true< / code > if the event had listeners, < code > false< / code > otherwise.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEmitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #008000" > // First listener< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > firstListener< / span > < span style = "color: #000000" > () {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Helloooo! first listener' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #008000" > // Second listener< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > secondListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > arg1< / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > arg2< / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > `event with parameters < / span > < span style = "color: #0000FF" > ${< / span > < span style = "color: #001080" > arg1< / span > < span style = "color: #0000FF" > }< / span > < span style = "color: #A31515" > , < / span > < span style = "color: #0000FF" > ${< / span > < span style = "color: #001080" > arg2< / span > < span style = "color: #0000FF" > }< / span > < span style = "color: #A31515" > in second listener`< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #008000" > // Third listener< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > thirdListener< / span > < span style = "color: #000000" > (...< / span > < span style = "color: #001080" > args< / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > parameters< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > args< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > join< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' , ' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > `event with parameters < / span > < span style = "color: #0000FF" > ${< / span > < span style = "color: #001080" > parameters< / span > < span style = "color: #0000FF" > }< / span > < span style = "color: #A31515" > in third listener`< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > listeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 1< / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 2< / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 3< / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 4< / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 5< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Prints:< / span >
< span style = "color: #008000" > // [< / span >
< span style = "color: #008000" > // [Function: firstListener],< / span >
< span style = "color: #008000" > // [Function: secondListener],< / span >
< span style = "color: #008000" > // [Function: thirdListener]< / span >
< span style = "color: #008000" > // ]< / span >
< span style = "color: #008000" > // Helloooo! first listener< / span >
< span style = "color: #008000" > // event with parameters 1, 2 in second listener< / span >
< span style = "color: #008000" > // event with parameters 1, 2, 3, 4, 5 in third listener< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.26< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "eventNames" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > event< wbr > Names< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< li class = "tsd-signature tsd-kind-icon" > event< wbr > Names< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > []< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.eventNames< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:614< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or < code > Symbol< / code > s.< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEE< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {});< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' bar' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {});< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > sym< / span > < span style = "color: #000000" > = < / span > < span style = "color: #267F99" > Symbol< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' symbol' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > sym< / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {});< / span >
< span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > eventNames< / span > < span style = "color: #000000" > ());< / span >
< span style = "color: #008000" > // Prints: [ ' foo' , ' bar' , Symbol(symbol) ]< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v6.0.0< / p >
< / dd >
< / dl >
< / div >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "export" class = "tsd-anchor" > < / a >
< h3 > export< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< li class = "tsd-signature tsd-kind-icon" > export< span class = "tsd-signature-symbol" > (< / span > direction< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > DirectionMode< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.export< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:45< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-07-24 15:12:56 +00:00
< h5 > direction: < span class = "tsd-signature-type" > DirectionMode< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "getMaxListeners" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > get< wbr > Max< wbr > Listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Max< wbr > Listeners< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.getMaxListeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:471< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the current max listener value for the < code > EventEmitter< / code > which is either
set by < code > emitter.setMaxListeners(n)< / code > or defaults to < a href = "gpio.GPIO.html#defaultMaxListeners" > defaultMaxListeners< / a > .< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v1.0.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "listenerCount" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > listener< wbr > Count< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > listener< wbr > Count< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.listenerCount< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:561< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the number of listeners listening to the event named < code > eventName< / code > .< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v3.2.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event being listened for< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "listeners" class = "tsd-anchor" > < / a >
< h3 > listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > listeners< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.listeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:484< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns a copy of the array of listeners for the event named < code > eventName< / code > .< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' someone connected!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > util< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > inspect< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > listeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > )));< / span >
< span style = "color: #008000" > // Prints: [ [Function] ]< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.26< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "off" class = "tsd-anchor" > < / a >
< h3 > off< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > off< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.off< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:444< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Alias for < code > emitter.removeListener()< / code > .< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v10.0.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "on" class = "tsd-anchor" > < / a >
< h3 > on< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > on< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.on< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:330< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Adds the < code > listener< / code > function to the end of the listeners array for the
event named < code > eventName< / code > . No checks are made to see if the < code > listener< / code > has
already been added. Multiple calls passing the same combination of < code > eventName< / code > and < code > listener< / code > will result in the < code > listener< / code > being added, and called, multiple
times.< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' someone connected!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< / code > < / pre >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< p > By default, event listeners are invoked in the order they are added. The< code > emitter.prependListener()< / code > method can be used as an alternative to add the
event listener to the beginning of the listeners array.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEE< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' a' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > prependListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' b' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Prints:< / span >
< span style = "color: #008000" > // b< / span >
< span style = "color: #008000" > // a< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.101< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event.< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< p > The callback function< / p >
< / div >
2020-02-11 00:08:19 +09:00
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "once" class = "tsd-anchor" > < / a >
< h3 > once< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > once< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.once< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:359< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Adds a < strong > one-time< / strong > < code > listener< / code > function for the event named < code > eventName< / code > . The
next time < code > eventName< / code > is triggered, this listener is removed and then invoked.< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Ah, we have our first user!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< / code > < / pre >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< p > By default, event listeners are invoked in the order they are added. The< code > emitter.prependOnceListener()< / code > method can be used as an alternative to add the
event listener to the beginning of the listeners array.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEE< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' a' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > prependOnceListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' b' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > myEE< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Prints:< / span >
< span style = "color: #008000" > // b< / span >
< span style = "color: #008000" > // a< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.3.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event.< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< p > The callback function< / p >
< / div >
2020-02-11 00:08:19 +09:00
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "prependListener" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > prepend< wbr > Listener< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > prepend< wbr > Listener< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.prependListener< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:579< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Adds the < code > listener< / code > function to the < em > beginning< / em > of the listeners array for the
event named < code > eventName< / code > . No checks are made to see if the < code > listener< / code > has
already been added. Multiple calls passing the same combination of < code > eventName< / code > and < code > listener< / code > will result in the < code > listener< / code > being added, and called, multiple
times.< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > prependListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' someone connected!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< / code > < / pre >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v6.0.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event.< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< p > The callback function< / p >
< / div >
2020-02-11 00:08:19 +09:00
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "prependOnceListener" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > prepend< wbr > Once< wbr > Listener< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > prepend< wbr > Once< wbr > Listener< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.prependOnceListener< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:595< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Adds a < strong > one-time< / strong > < code > listener< / code > function for the event named < code > eventName< / code > to the_beginning_ of the listeners array. The next time < code > eventName< / code > is triggered, this
listener is removed, and then invoked.< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > prependOnceListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Ah, we have our first user!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< / code > < / pre >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v6.0.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event.< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< p > The callback function< / p >
< / div >
2020-02-11 00:08:19 +09:00
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "rawListeners" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > raw< wbr > Listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > raw< wbr > Listeners< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.rawListeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:514< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns a copy of the array of listeners for the event named < code > eventName< / code > ,
including any wrappers (such as those created by < code > .once()< / code > ).< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > emitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log once' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #008000" > // Returns a new Array with a function `onceWrapper` which has a property< / span >
< span style = "color: #008000" > // `listener` which contains the original listener bound above< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > listeners< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > rawListeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > logFnWrapper< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > listeners< / span > < span style = "color: #000000" > [< / span > < span style = "color: #098658" > 0< / span > < span style = "color: #000000" > ];< / span >
< span style = "color: #008000" > // Logs " log once" to the console and does not unbind the `once` event< / span >
< span style = "color: #001080" > logFnWrapper< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > listener< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #008000" > // Logs " log once" to the console and removes the listener< / span >
< span style = "color: #795E26" > logFnWrapper< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log persistently' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #008000" > // Will return a new Array with a single function bound by `.on()` above< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > newListeners< / span > < span style = "color: #000000" > = < / span > < span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > rawListeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Logs " log persistently" twice< / span >
< span style = "color: #001080" > newListeners< / span > < span style = "color: #000000" > [< / span > < span style = "color: #098658" > 0< / span > < span style = "color: #000000" > ]();< / span >
< span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' log' < / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v9.4.0< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
2020-02-11 00:08:19 +09:00
< a name = "read" class = "tsd-anchor" > < / a >
< h3 > read< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
< li class = "tsd-signature tsd-kind-icon" > read< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/gpio.html#GPIOValue" class = "tsd-signature-type" data-tsd-kind = "Type alias" > GPIOValue< / a > < span class = "tsd-signature-symbol" > > < / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Overrides GPIOPort.read< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in < a href = "https://github.com/kou029w/megabit/blob/2ffbb73/src/gpio.ts#L12" > src/gpio.ts:12< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "../modules/gpio.html#GPIOValue" class = "tsd-signature-type" data-tsd-kind = "Type alias" > GPIOValue< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "removeAllListeners" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > remove< wbr > All< wbr > Listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< li class = "tsd-signature tsd-kind-icon" > remove< wbr > All< wbr > Listeners< span class = "tsd-signature-symbol" > (< / span > event< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.removeAllListeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:455< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Removes all listeners, or those of the specified < code > eventName< / code > .< / p >
< / div >
< p > It is bad practice to remove listeners added elsewhere in the code,
particularly when the < code > EventEmitter< / code > instance was created by some other
component or module (e.g. sockets or file streams).< / p >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.26< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > event: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "removeListener" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > remove< wbr > Listener< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > remove< wbr > Listener< span class = "tsd-signature-symbol" > (< / span > eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , listener< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.removeListener< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:439< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Removes the specified < code > listener< / code > from the listener array for the event named< code > eventName< / code > .< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > callback< / span > < span style = "color: #000000" > = (< / span > < span style = "color: #001080" > stream< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' someone connected!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > };< / span >
< span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > callback< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // ...< / span >
< span style = "color: #001080" > server< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > removeListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' connection' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > callback< / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
< p > < code > removeListener()< / code > will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified < code > eventName< / code > , then < code > removeListener()< / code > must be
called multiple times to remove each instance.< / p >
< p > Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any< code > removeListener()< / code > or < code > removeAllListeners()< / code > calls < em > after< / em > emitting and_before_ the last listener finishes execution will
not remove them from< code > emit()< / code > in progress. Subsequent events behave as expected.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEmitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > MyEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > callbackA< / span > < span style = "color: #000000" > = () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' A' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > removeListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > callbackB< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > };< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > callbackB< / span > < span style = "color: #000000" > = () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' B' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > };< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > callbackA< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > callbackB< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // callbackA removes listener callbackB but it will still be called.< / span >
< span style = "color: #008000" > // Internal listener array at time of emit [callbackA, callbackB]< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Prints:< / span >
< span style = "color: #008000" > // A< / span >
< span style = "color: #008000" > // B< / span >
< span style = "color: #008000" > // callbackB is now removed.< / span >
< span style = "color: #008000" > // Internal listener array [callbackA]< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #008000" > // Prints:< / span >
< span style = "color: #008000" > // A< / span >
< / code > < / pre >
< p > Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered < em > after< / em > the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the < code > emitter.listeners()< / code > method will need to be recreated.< / p >
< p > When a single function has been added as a handler multiple times for a single
event (as in the example below), < code > removeListener()< / code > will remove the most
recently added instance. In the example the < code > once(' ping' )< / code > listener is removed:< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ee< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > pong< / span > < span style = "color: #000000" > () {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' pong' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ping' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > pong< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ping' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > pong< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > removeListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ping' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > pong< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ping' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ping' < / span > < span style = "color: #000000" > );< / span >
< / code > < / pre >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.1.26< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< li >
< h5 > listener: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
< ul class = "tsd-parameters" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > ...< / span > args< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagRest" > Rest< / span > < span class = "tsd-signature-symbol" > ...< / span > args: < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a name = "setMaxListeners" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > set< wbr > Max< wbr > Listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< li class = "tsd-signature tsd-kind-icon" > set< wbr > Max< wbr > Listeners< span class = "tsd-signature-symbol" > (< / span > n< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.setMaxListeners< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:465< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > By default < code > EventEmitter< / code > s will print a warning if more than < code > 10< / code > listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The < code > emitter.setMaxListeners()< / code > method allows the limit to be
modified for this specific < code > EventEmitter< / code > instance. The value can be set to< code > Infinity< / code > (or < code > 0< / code > ) to indicate an unlimited number of listeners.< / p >
< / div >
< p > Returns a reference to the < code > EventEmitter< / code > , so that calls can be chained.< / p >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v0.3.5< / p >
< / dd >
< / dl >
< / div >
2020-02-11 00:08:19 +09:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > n: < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "gpio.GPIO.html" class = "tsd-signature-type" data-tsd-kind = "Class" > GPIO< / a > < / h4 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< a name = "unexport" class = "tsd-anchor" > < / a >
< h3 > unexport< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
2020-02-11 00:08:19 +09:00
< li class = "tsd-signature tsd-kind-icon" > unexport< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.unexport< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-03 07:21:55 +00:00
< li > Defined in node_modules/node-web-gpio/dist/index.d.ts:46< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
2020-02-11 00:08:19 +09:00
< a name = "write" class = "tsd-anchor" > < / a >
< h3 > write< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
< li class = "tsd-signature tsd-kind-icon" > write< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > : < / span > < a href = "../modules/gpio.html#GPIOValue" class = "tsd-signature-type" data-tsd-kind = "Type alias" > GPIOValue< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Overrides GPIOPort.write< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in < a href = "https://github.com/kou029w/megabit/blob/2ffbb73/src/gpio.ts#L25" > src/gpio.ts:25< / a > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-07-24 15:12:56 +00:00
< h5 > value: < a href = "../modules/gpio.html#GPIOValue" class = "tsd-signature-type" data-tsd-kind = "Type alias" > GPIOValue< / a > < / h5 >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< a name = "getEventListeners" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > get< wbr > Event< wbr > Listeners< / h3 >
2021-07-24 15:12:56 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Event< wbr > Listeners< span class = "tsd-signature-symbol" > (< / span > emitter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > DOMEventTarget< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > EventEmitter< / span > , name< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / li >
2021-07-24 15:12:56 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-09-04 04:29:30 +00:00
< p > Inherited from GPIOPort.getEventListeners< / p >
2021-07-24 15:12:56 +00:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:262< / li >
2021-07-24 15:12:56 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2021-09-04 04:29:30 +00:00
< p > Returns a copy of the array of listeners for the event named < code > eventName< / code > .< / p >
2021-07-24 15:12:56 +00:00
< / div >
2021-09-04 04:29:30 +00:00
< p > For < code > EventEmitter< / code > s this behaves exactly the same as calling < code > .listeners< / code > on
the emitter.< / p >
< p > For < code > EventTarget< / code > s this is the only way to get the event listeners for the
event target. This is useful for debugging and diagnostic purposes.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > { < / span > < span style = "color: #0070C1" > getEventListeners< / span > < span style = "color: #000000" > , < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > } = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ee< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > listener< / span > < span style = "color: #000000" > = () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Events are fun' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > listener< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #795E26" > getEventListeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > ); < / span > < span style = "color: #008000" > // [listener]< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > et< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventTarget< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > listener< / span > < span style = "color: #000000" > = () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Events are fun' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > et< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > addEventListener< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > listener< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #795E26" > getEventListeners< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > et< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > ); < / span > < span style = "color: #008000" > // [listener]< / span >
< span style = "color: #000000" > }< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v15.2.0< / p >
< / dd >
< / dl >
2021-07-24 15:12:56 +00:00
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > emitter: < span class = "tsd-signature-type" > DOMEventTarget< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > EventEmitter< / span > < / h5 >
< / li >
< li >
< h5 > name: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Function< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "listenerCount-1" class = "tsd-anchor" > < / a >
2020-02-11 00:08:19 +09:00
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > listener< wbr > Count< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > listener< wbr > Count< span class = "tsd-signature-symbol" > (< / span > emitter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > EventEmitter< / span > , eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
2021-07-24 15:12:56 +00:00
< p > Inherited from GPIOPort.listenerCount< / p >
2020-02-11 00:08:19 +09:00
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:234< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
2021-09-04 04:29:30 +00:00
< div class = "lead" >
< p > A class method that returns the number of listeners for the given < code > eventName< / code > registered on the given < code > emitter< / code > .< / p >
< / div >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > { < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #0070C1" > listenerCount< / span > < span style = "color: #000000" > } = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > myEmitter< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {});< / span >
< span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > on< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > , () < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {});< / span >
< span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #795E26" > listenerCount< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > myEmitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' event' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #008000" > // Prints: 2< / span >
< / code > < / pre >
2020-02-11 00:08:19 +09:00
< dl class = "tsd-comment-tags" >
2021-09-04 04:29:30 +00:00
< dt > since< / dt >
< dd > < p > v0.9.12< / p >
< / dd >
2020-02-11 00:08:19 +09:00
< dt > deprecated< / dt >
2021-09-04 04:29:30 +00:00
< dd > < p > Since v3.2.0 - Use < code > listenerCount< / code > instead.< / p >
2020-02-11 00:08:19 +09:00
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > emitter: < span class = "tsd-signature-type" > EventEmitter< / span > < / h5 >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< p > The emitter to query< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The event name< / p >
< / div >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
2021-07-24 15:12:56 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "on-1" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > on< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > on< span class = "tsd-signature-symbol" > (< / span > emitter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > EventEmitter< / span > , eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > AsyncIterableIterator< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
2021-07-24 15:12:56 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< p > Inherited from GPIOPort.on< / p >
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:217< / li >
2021-07-24 15:12:56 +00:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > ```js
const { on, EventEmitter } = require(' events' );< / p >
< / div >
< p > (async () => {
const ee = new EventEmitter();< / p >
< p > // Emit later on
process.nextTick(() => {
ee.emit(' foo' , ' bar' );
ee.emit(' foo' , 42);
});< / p >
< p > for await (const event of on(ee, ' foo' )) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints [' bar' ] [42]
}
// Unreachable here
})();< / p >
< pre > < code >
< span style = "color: #001080" > Returns< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > an< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `AsyncIterator`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > that< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > iterates< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `eventName`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > events< / span > < span style = "color: #000000" > . < / span > < span style = "color: #001080" > It< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > will< / span > < span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > throw< / span >
< span style = "color: #AF00DB" > if< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > the< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `EventEmitter`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > emits< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `' error' `< / span > < span style = "color: #000000" > . < / span > < span style = "color: #001080" > It< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > removes< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > all< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > listeners< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > when< / span >
< span style = "color: #001080" > exiting< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > the< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > loop< / span > < span style = "color: #000000" > . < / span > < span style = "color: #001080" > The< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `value`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > returned< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > by< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > each< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > iteration< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > is< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > an< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > array< / span >
< span style = "color: #001080" > composed< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > of< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > the< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > emitted< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > event< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > arguments< / span > < span style = "color: #000000" > .< / span >
< span style = "color: #001080" > An< / span > < span style = "color: #000000" > < / span > < span style = "color: #A31515" > `AbortSignal`< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > can< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > be< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > used< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > to< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > cancel< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > waiting< / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > on< / span > < span style = "color: #000000" > events:< / span >
< span style = "color: #A31515" > ```js< / span >
< span style = "color: #A31515" > const { on, EventEmitter } = require(' events' );< / span >
< span style = "color: #A31515" > const ac = new AbortController();< / span >
< span style = "color: #A31515" > (async () => {< / span >
< span style = "color: #A31515" > const ee = new EventEmitter();< / span >
< span style = "color: #A31515" > // Emit later on< / span >
< span style = "color: #A31515" > process.nextTick(() => {< / span >
< span style = "color: #A31515" > ee.emit(' foo' , ' bar' );< / span >
< span style = "color: #A31515" > ee.emit(' foo' , 42);< / span >
< span style = "color: #A31515" > });< / span >
< span style = "color: #A31515" > for await (const event of on(ee, ' foo' , { signal: ac.signal })) {< / span >
< span style = "color: #A31515" > // The execution of this inner block is synchronous and it< / span >
< span style = "color: #A31515" > // processes one event at a time (even with await). Do not use< / span >
< span style = "color: #A31515" > // if concurrent execution is required.< / span >
< span style = "color: #A31515" > console.log(event); // prints [' bar' ] [42]< / span >
< span style = "color: #A31515" > }< / span >
< span style = "color: #A31515" > // Unreachable here< / span >
< span style = "color: #A31515" > })();< / span >
< span style = "color: #A31515" > process.nextTick(() => ac.abort());< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v13.6.0, v12.16.0< / p >
< / dd >
< / dl >
< / div >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > emitter: < span class = "tsd-signature-type" > EventEmitter< / span > < / h5 >
< / li >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The name of the event being listened for< / p >
< / div >
2021-07-24 15:12:56 +00:00
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > AsyncIterableIterator< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
2021-09-04 04:29:30 +00:00
< p > that iterates < code > eventName< / code > events emitted by the < code > emitter< / code > < / p >
2021-07-24 15:12:56 +00:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a name = "once-1" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagStatic" > Static< / span > once< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > once< span class = "tsd-signature-symbol" > (< / span > emitter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > NodeEventTarget< / span > , eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< li class = "tsd-signature tsd-kind-icon" > once< span class = "tsd-signature-symbol" > (< / span > emitter< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > DOMEventTarget< / span > , eventName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
2021-07-24 15:12:56 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< p > Inherited from GPIOPort.once< / p >
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:157< / li >
2021-07-24 15:12:56 +00:00
< / ul >
< / aside >
2021-09-04 04:29:30 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates a < code > Promise< / code > that is fulfilled when the < code > EventEmitter< / code > emits the given
event or that is rejected if the < code > EventEmitter< / code > emits < code > ' error' < / code > while waiting.
The < code > Promise< / code > will resolve with an array of all the arguments emitted to the
given event.< / p >
< / div >
< p > This method is intentionally generic and works with the web platform< a href = "https://dom.spec.whatwg.org/#interface-eventtarget" > EventTarget< / a > interface, which has no special< code > ' error' < / code > event
semantics and does not listen to the < code > ' error' < / code > event.< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > { < / span > < span style = "color: #0070C1" > once< / span > < span style = "color: #000000" > , < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > } = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > async< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > run< / span > < span style = "color: #000000" > () {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ee< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > process< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > nextTick< / span > < span style = "color: #000000" > (() < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' myevent' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #098658" > 42< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > [< / span > < span style = "color: #0070C1" > value< / span > < span style = "color: #000000" > ] = < / span > < span style = "color: #AF00DB" > await< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' myevent' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > value< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > err< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #267F99" > Error< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' kaboom' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > process< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > nextTick< / span > < span style = "color: #000000" > (() < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' error' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > });< / span >
< span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > try< / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > await< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' myevent' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > } < / span > < span style = "color: #AF00DB" > catch< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' error happened' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #795E26" > run< / span > < span style = "color: #000000" > ();< / span >
< / code > < / pre >
< p > The special handling of the < code > ' error' < / code > event is only used when < code > events.once()< / code > is used to wait for another event. If < code > events.once()< / code > is used to wait for the
' < code > error' < / code > event itself, then it is treated as any other kind of event without
special handling:< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > { < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #0070C1" > once< / span > < span style = "color: #000000" > } = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ee< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' error' < / span > < span style = "color: #000000" > )< / span >
< span style = "color: #000000" > .< / span > < span style = "color: #795E26" > then< / span > < span style = "color: #000000" > (([< / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > ]) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' ok' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > message< / span > < span style = "color: #000000" > ))< / span >
< span style = "color: #000000" > .< / span > < span style = "color: #795E26" > catch< / span > < span style = "color: #000000" > ((< / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > ) < / span > < span style = "color: #0000FF" > => < / span > < span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' error' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > err< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > message< / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' error' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #267F99" > Error< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' boom' < / span > < span style = "color: #000000" > ));< / span >
< span style = "color: #008000" > // Prints: ok boom< / span >
< / code > < / pre >
< p > An < code > AbortSignal< / code > can be used to cancel waiting for the event:< / p >
< pre > < code class = "language-js" > < span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > { < / span > < span style = "color: #0070C1" > EventEmitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #0070C1" > once< / span > < span style = "color: #000000" > } = < / span > < span style = "color: #795E26" > require< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' events' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ee< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > EventEmitter< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #0000FF" > const< / span > < span style = "color: #000000" > < / span > < span style = "color: #0070C1" > ac< / span > < span style = "color: #000000" > = < / span > < span style = "color: #0000FF" > new< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > AbortController< / span > < span style = "color: #000000" > ();< / span >
< span style = "color: #0000FF" > async< / span > < span style = "color: #000000" > < / span > < span style = "color: #0000FF" > function< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > foo< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > event< / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > signal< / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > try< / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > await< / span > < span style = "color: #000000" > < / span > < span style = "color: #795E26" > once< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > emitter< / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > event< / span > < span style = "color: #000000" > , { < / span > < span style = "color: #001080" > signal< / span > < span style = "color: #000000" > });< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > log< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' event emitted!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > } < / span > < span style = "color: #AF00DB" > catch< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > error< / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #AF00DB" > if< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > error< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > name< / span > < span style = "color: #000000" > === < / span > < span style = "color: #A31515" > ' AbortError' < / span > < span style = "color: #000000" > ) {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > error< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' Waiting for the event was canceled!' < / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > } < / span > < span style = "color: #AF00DB" > else< / span > < span style = "color: #000000" > {< / span >
< span style = "color: #000000" > < / span > < span style = "color: #001080" > console< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > error< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' There was an error' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > error< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > message< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #000000" > }< / span >
< span style = "color: #795E26" > foo< / span > < span style = "color: #000000" > (< / span > < span style = "color: #001080" > ee< / span > < span style = "color: #000000" > , < / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > , < / span > < span style = "color: #001080" > ac< / span > < span style = "color: #000000" > .< / span > < span style = "color: #001080" > signal< / span > < span style = "color: #000000" > );< / span >
< span style = "color: #001080" > ac< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > abort< / span > < span style = "color: #000000" > (); < / span > < span style = "color: #008000" > // Abort waiting for the event< / span >
< span style = "color: #001080" > ee< / span > < span style = "color: #000000" > .< / span > < span style = "color: #795E26" > emit< / span > < span style = "color: #000000" > (< / span > < span style = "color: #A31515" > ' foo' < / span > < span style = "color: #000000" > ); < / span > < span style = "color: #008000" > // Prints: Waiting for the event was canceled!< / span >
< / code > < / pre >
< dl class = "tsd-comment-tags" >
< dt > since< / dt >
< dd > < p > v11.13.0, v10.16.0< / p >
< / dd >
< / dl >
< / div >
2021-07-24 15:12:56 +00:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > emitter: < span class = "tsd-signature-type" > NodeEventTarget< / span > < / h5 >
< / li >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > symbol< / span > < / h5 >
2021-07-24 15:12:56 +00:00
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< p > Inherited from GPIOPort.once< / p >
< ul >
2021-09-04 04:29:30 +00:00
< li > Defined in node_modules/@types/node/events.d.ts:158< / li >
2021-07-24 15:12:56 +00:00
< / ul >
< / aside >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > emitter: < span class = "tsd-signature-type" > DOMEventTarget< / span > < / h5 >
< / li >
< li >
2021-09-04 04:29:30 +00:00
< h5 > eventName: < span class = "tsd-signature-type" > string< / span > < / h5 >
2021-07-24 15:12:56 +00:00
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-type" > StaticEventEmitterOptions< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
2020-02-11 00:08:19 +09:00
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
2021-07-24 15:12:56 +00:00
< li class = " " >
< a href = "../modules.html" > Modules< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/Device.html" > Device< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/ads1015.html" > ads1015< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/adt7410.html" > adt7410< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/adxl345.html" > adxl345< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/gp2y0e03.html" > gp2y0e03< / a >
< / li >
< li class = "current tsd-kind-module" >
< a href = "../modules/gpio.html" > gpio< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/i2c.html" > i2c< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/index.html" > index< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/mpr121.html" > mpr121< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/paj7620.html" > paj7620< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/pca9685.html" > pca9685< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/s11059.html" > s11059< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/sht30.html" > sht30< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/ssd1306.html" > ssd1306< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/ssd1308.html" > ssd1308< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/tsl2561.html" > tsl2561< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/veml6070.html" > veml6070< / a >
< / li >
< li class = " tsd-kind-module" >
< a href = "../modules/vl53l0x.html" > vl53l0x< / a >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-reference tsd-parent-kind-module" >
< a href = "../modules/gpio.html#default" class = "tsd-kind-icon" > default< / a >
< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "current" >
2021-07-24 15:12:56 +00:00
< li class = "current tsd-kind-class tsd-parent-kind-module" >
< a href = "gpio.GPIO.html" class = "tsd-kind-icon" > GPIO< / a >
2020-02-11 00:08:19 +09:00
< ul >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" >
< a href = "gpio.GPIO.html#constructor" class = "tsd-kind-icon" > constructor< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#onchange" class = "tsd-kind-icon" > onchange< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#captureRejectionSymbol" class = "tsd-kind-icon" > capture< wbr > Rejection< wbr > Symbol< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#captureRejections" class = "tsd-kind-icon" > capture< wbr > Rejections< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#defaultMaxListeners" class = "tsd-kind-icon" > default< wbr > Max< wbr > Listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#errorMonitor" class = "tsd-kind-icon" > error< wbr > Monitor< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#direction" class = "tsd-kind-icon" > direction< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#exported" class = "tsd-kind-icon" > exported< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#pinName" class = "tsd-kind-icon" > pin< wbr > Name< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#portName" class = "tsd-kind-icon" > port< wbr > Name< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class tsd-is-external" >
2021-07-24 15:12:56 +00:00
< a href = "gpio.GPIO.html#portNumber" class = "tsd-kind-icon" > port< wbr > Number< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#addListener" class = "tsd-kind-icon" > add< wbr > Listener< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#emit" class = "tsd-kind-icon" > emit< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#eventNames" class = "tsd-kind-icon" > event< wbr > Names< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#export" class = "tsd-kind-icon" > export< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#getMaxListeners" class = "tsd-kind-icon" > get< wbr > Max< wbr > Listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#listenerCount" class = "tsd-kind-icon" > listener< wbr > Count< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#listeners" class = "tsd-kind-icon" > listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#off" class = "tsd-kind-icon" > off< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#on" class = "tsd-kind-icon" > on< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#once" class = "tsd-kind-icon" > once< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#prependListener" class = "tsd-kind-icon" > prepend< wbr > Listener< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#prependOnceListener" class = "tsd-kind-icon" > prepend< wbr > Once< wbr > Listener< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#rawListeners" class = "tsd-kind-icon" > raw< wbr > Listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
< a href = "gpio.GPIO.html#read" class = "tsd-kind-icon" > read< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#removeAllListeners" class = "tsd-kind-icon" > remove< wbr > All< wbr > Listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#removeListener" class = "tsd-kind-icon" > remove< wbr > Listener< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#setMaxListeners" class = "tsd-kind-icon" > set< wbr > Max< wbr > Listeners< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external" >
< a href = "gpio.GPIO.html#unexport" class = "tsd-kind-icon" > unexport< / a >
2020-02-11 00:08:19 +09:00
< / li >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-overwrite" >
< a href = "gpio.GPIO.html#write" class = "tsd-kind-icon" > write< / a >
2020-02-11 00:08:19 +09:00
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
2021-09-04 04:29:30 +00:00
< a href = "gpio.GPIO.html#getEventListeners" class = "tsd-kind-icon" > get< wbr > Event< wbr > Listeners< / a >
2021-07-24 15:12:56 +00:00
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#listenerCount-1" class = "tsd-kind-icon" > listener< wbr > Count< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#on-1" class = "tsd-kind-icon" > on< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external" >
< a href = "gpio.GPIO.html#once-1" class = "tsd-kind-icon" > once< / a >
2020-02-11 00:08:19 +09:00
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
2021-07-24 15:12:56 +00:00
< li class = " tsd-kind-class tsd-parent-kind-module tsd-is-external" >
< a href = "gpio.InvalidAccessError.html" class = "tsd-kind-icon" > Invalid< wbr > Access< wbr > Error< / a >
< / li >
< li class = " tsd-kind-class tsd-parent-kind-module tsd-is-external" >
< a href = "gpio.OperationError.html" class = "tsd-kind-icon" > Operation< wbr > Error< / a >
< / li >
< li class = " tsd-kind-type-alias tsd-parent-kind-module" >
< a href = "../modules/gpio.html#GPIOValue" class = "tsd-kind-icon" > GPIOValue< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-module" >
< a href = "../modules/gpio.html#gpio-1" class = "tsd-kind-icon" > gpio< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-module tsd-is-external" >
< a href = "../modules/gpio.html#requestGPIOAccess" class = "tsd-kind-icon" > requestGPIOAccess< / a >
< / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-function" > < span class = "tsd-kind-icon" > Function< / span > < / li >
< li class = "tsd-kind-type-alias" > < span class = "tsd-kind-icon" > Type alias< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-class" > < span class = "tsd-kind-icon" > Class< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-interface tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Interface with type parameter< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< ul class = "tsd-legend" >
2021-07-24 15:12:56 +00:00
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
2020-02-11 00:08:19 +09:00
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
