LuCI.fs.html 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Class: fs</title>
  6. <script src="scripts/prettify/prettify.js"></script>
  7. <script src="scripts/prettify/lang-css.js"></script>
  8. <script src="scripts/jquery.min.js"></script>
  9. <!--[if lt IE 9]>
  10. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11. <![endif]-->
  12. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  13. <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
  14. <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
  15. <script>
  16. var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
  17. </script>
  18. </head>
  19. <body>
  20. <div id="wrap" class="clearfix">
  21. <div class="navigation">
  22. <h3 class="applicationName"><a href="index.html"></a></h3>
  23. <div class="search">
  24. <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
  25. </div>
  26. <ul class="list">
  27. <li class="item" data-name="LuCI">
  28. <span class="title">
  29. <a href="LuCI.html">LuCI</a>
  30. </span>
  31. <ul class="members itemMembers">
  32. <span class="subtitle">Members</span>
  33. <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
  34. </ul>
  35. <ul class="typedefs itemMembers">
  36. <span class="subtitle">Typedefs</span>
  37. <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
  38. </ul>
  39. <ul class="typedefs itemMembers">
  40. </ul>
  41. <ul class="methods itemMembers">
  42. <span class="subtitle">Methods</span>
  43. <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
  44. <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
  45. <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
  46. <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
  47. <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
  48. <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
  49. <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
  50. <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
  51. <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
  52. <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
  53. <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
  54. <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
  55. <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
  56. <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
  57. <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
  58. <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
  59. <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
  60. <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
  61. <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
  62. </ul>
  63. <ul class="events itemMembers">
  64. </ul>
  65. </li>
  66. <li class="item" data-name="LuCI.Class">
  67. <span class="title">
  68. <a href="LuCI.Class.html">LuCI.Class</a>
  69. </span>
  70. <ul class="members itemMembers">
  71. </ul>
  72. <ul class="typedefs itemMembers">
  73. </ul>
  74. <ul class="typedefs itemMembers">
  75. </ul>
  76. <ul class="methods itemMembers">
  77. <span class="subtitle">Methods</span>
  78. <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
  79. <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
  80. <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
  81. <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
  82. <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
  83. <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
  84. </ul>
  85. <ul class="events itemMembers">
  86. </ul>
  87. </li>
  88. <li class="item" data-name="LuCI.dom">
  89. <span class="title">
  90. <a href="LuCI.dom.html">LuCI.dom</a>
  91. </span>
  92. <ul class="members itemMembers">
  93. </ul>
  94. <ul class="typedefs itemMembers">
  95. <span class="subtitle">Typedefs</span>
  96. <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
  97. </ul>
  98. <ul class="typedefs itemMembers">
  99. </ul>
  100. <ul class="methods itemMembers">
  101. <span class="subtitle">Methods</span>
  102. <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
  103. <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
  104. <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
  105. <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
  106. <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
  107. <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
  108. <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
  109. <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
  110. <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
  111. <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
  112. <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
  113. <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
  114. <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
  115. </ul>
  116. <ul class="events itemMembers">
  117. </ul>
  118. </li>
  119. <li class="item" data-name="LuCI.fs">
  120. <span class="title">
  121. <a href="LuCI.fs.html">LuCI.fs</a>
  122. </span>
  123. <ul class="members itemMembers">
  124. </ul>
  125. <ul class="typedefs itemMembers">
  126. <span class="subtitle">Typedefs</span>
  127. <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
  128. <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
  129. </ul>
  130. <ul class="typedefs itemMembers">
  131. </ul>
  132. <ul class="methods itemMembers">
  133. <span class="subtitle">Methods</span>
  134. <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
  135. <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
  136. <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
  137. <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
  138. <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
  139. <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
  140. <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
  141. <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
  142. </ul>
  143. <ul class="events itemMembers">
  144. </ul>
  145. </li>
  146. <li class="item" data-name="LuCI.Headers">
  147. <span class="title">
  148. <a href="LuCI.Headers.html">LuCI.Headers</a>
  149. </span>
  150. <ul class="members itemMembers">
  151. </ul>
  152. <ul class="typedefs itemMembers">
  153. </ul>
  154. <ul class="typedefs itemMembers">
  155. </ul>
  156. <ul class="methods itemMembers">
  157. <span class="subtitle">Methods</span>
  158. <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
  159. <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
  160. </ul>
  161. <ul class="events itemMembers">
  162. </ul>
  163. </li>
  164. <li class="item" data-name="LuCI.Network">
  165. <span class="title">
  166. <a href="LuCI.Network.html">LuCI.Network</a>
  167. </span>
  168. <ul class="members itemMembers">
  169. </ul>
  170. <ul class="typedefs itemMembers">
  171. <span class="subtitle">Typedefs</span>
  172. <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
  173. <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
  174. <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
  175. <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
  176. <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
  177. </ul>
  178. <ul class="typedefs itemMembers">
  179. </ul>
  180. <ul class="methods itemMembers">
  181. <span class="subtitle">Methods</span>
  182. <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
  183. <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
  184. <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
  185. <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
  186. <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
  187. <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
  188. <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
  189. <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
  190. <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
  191. <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
  192. <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
  193. <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
  194. <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
  195. <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
  196. <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
  197. <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
  198. <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
  199. <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
  200. <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
  201. <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
  202. <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
  203. <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li>
  204. <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
  205. <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
  206. <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
  207. <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
  208. <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
  209. <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
  210. <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
  211. </ul>
  212. <ul class="events itemMembers">
  213. </ul>
  214. </li>
  215. <li class="item" data-name="LuCI.Network.Device">
  216. <span class="title">
  217. <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
  218. </span>
  219. <ul class="members itemMembers">
  220. </ul>
  221. <ul class="typedefs itemMembers">
  222. </ul>
  223. <ul class="typedefs itemMembers">
  224. </ul>
  225. <ul class="methods itemMembers">
  226. <span class="subtitle">Methods</span>
  227. <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
  228. <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
  229. <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
  230. <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
  231. <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
  232. <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
  233. <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
  234. <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
  235. <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
  236. <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
  237. <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
  238. <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
  239. <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
  240. <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
  241. <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
  242. <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
  243. <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
  244. <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
  245. <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
  246. <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
  247. <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
  248. <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
  249. </ul>
  250. <ul class="events itemMembers">
  251. </ul>
  252. </li>
  253. <li class="item" data-name="LuCI.Network.Hosts">
  254. <span class="title">
  255. <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
  256. </span>
  257. <ul class="members itemMembers">
  258. </ul>
  259. <ul class="typedefs itemMembers">
  260. </ul>
  261. <ul class="typedefs itemMembers">
  262. </ul>
  263. <ul class="methods itemMembers">
  264. <span class="subtitle">Methods</span>
  265. <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
  266. <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
  267. <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
  268. <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
  269. <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
  270. <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
  271. <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
  272. <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
  273. </ul>
  274. <ul class="events itemMembers">
  275. </ul>
  276. </li>
  277. <li class="item" data-name="LuCI.Network.Protocol">
  278. <span class="title">
  279. <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
  280. </span>
  281. <ul class="members itemMembers">
  282. </ul>
  283. <ul class="typedefs itemMembers">
  284. </ul>
  285. <ul class="typedefs itemMembers">
  286. </ul>
  287. <ul class="methods itemMembers">
  288. <span class="subtitle">Methods</span>
  289. <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
  290. <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
  291. <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
  292. <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
  293. <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
  294. <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
  295. <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
  296. <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
  297. <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
  298. <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
  299. <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
  300. <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
  301. <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
  302. <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
  303. <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
  304. <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
  305. <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
  306. <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
  307. <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
  308. <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
  309. <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
  310. <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
  311. <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
  312. <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
  313. <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
  314. <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
  315. <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
  316. <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
  317. <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
  318. <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
  319. <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
  320. <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
  321. <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
  322. <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
  323. <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
  324. <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
  325. <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
  326. <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
  327. </ul>
  328. <ul class="events itemMembers">
  329. </ul>
  330. </li>
  331. <li class="item" data-name="LuCI.Network.WifiDevice">
  332. <span class="title">
  333. <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
  334. </span>
  335. <ul class="members itemMembers">
  336. </ul>
  337. <ul class="typedefs itemMembers">
  338. </ul>
  339. <ul class="typedefs itemMembers">
  340. </ul>
  341. <ul class="methods itemMembers">
  342. <span class="subtitle">Methods</span>
  343. <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
  344. <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
  345. <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
  346. <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
  347. <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
  348. <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
  349. <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
  350. <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
  351. <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
  352. <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
  353. <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
  354. <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
  355. <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
  356. </ul>
  357. <ul class="events itemMembers">
  358. </ul>
  359. </li>
  360. <li class="item" data-name="LuCI.Network.WifiNetwork">
  361. <span class="title">
  362. <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
  363. </span>
  364. <ul class="members itemMembers">
  365. </ul>
  366. <ul class="typedefs itemMembers">
  367. </ul>
  368. <ul class="typedefs itemMembers">
  369. </ul>
  370. <ul class="methods itemMembers">
  371. <span class="subtitle">Methods</span>
  372. <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li>
  373. <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
  374. <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
  375. <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
  376. <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
  377. <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
  378. <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
  379. <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
  380. <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
  381. <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
  382. <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
  383. <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
  384. <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
  385. <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
  386. <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
  387. <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
  388. <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
  389. <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
  390. <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
  391. <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
  392. <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
  393. <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
  394. <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
  395. <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
  396. <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
  397. <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
  398. <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
  399. <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
  400. <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
  401. <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
  402. <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
  403. <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
  404. <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
  405. <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li>
  406. <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
  407. <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
  408. <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
  409. </ul>
  410. <ul class="events itemMembers">
  411. </ul>
  412. </li>
  413. <li class="item" data-name="LuCI.Poll">
  414. <span class="title">
  415. <a href="LuCI.Poll.html">LuCI.Poll</a>
  416. </span>
  417. <ul class="members itemMembers">
  418. </ul>
  419. <ul class="typedefs itemMembers">
  420. </ul>
  421. <ul class="typedefs itemMembers">
  422. </ul>
  423. <ul class="methods itemMembers">
  424. <span class="subtitle">Methods</span>
  425. <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
  426. <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
  427. <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
  428. <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
  429. <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
  430. </ul>
  431. <ul class="events itemMembers">
  432. </ul>
  433. </li>
  434. <li class="item" data-name="LuCI.Request">
  435. <span class="title">
  436. <a href="LuCI.Request.html">LuCI.Request</a>
  437. </span>
  438. <ul class="members itemMembers">
  439. </ul>
  440. <ul class="typedefs itemMembers">
  441. <span class="subtitle">Typedefs</span>
  442. <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
  443. <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
  444. </ul>
  445. <ul class="typedefs itemMembers">
  446. </ul>
  447. <ul class="methods itemMembers">
  448. <span class="subtitle">Methods</span>
  449. <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
  450. <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
  451. <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
  452. <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
  453. <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
  454. <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
  455. </ul>
  456. <ul class="events itemMembers">
  457. </ul>
  458. </li>
  459. <li class="item" data-name="LuCI.Request.poll">
  460. <span class="title">
  461. <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
  462. </span>
  463. <ul class="members itemMembers">
  464. </ul>
  465. <ul class="typedefs itemMembers">
  466. <span class="subtitle">Typedefs</span>
  467. <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
  468. </ul>
  469. <ul class="typedefs itemMembers">
  470. </ul>
  471. <ul class="methods itemMembers">
  472. <span class="subtitle">Methods</span>
  473. <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
  474. <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
  475. <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
  476. <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
  477. <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
  478. </ul>
  479. <ul class="events itemMembers">
  480. </ul>
  481. </li>
  482. <li class="item" data-name="LuCI.Response">
  483. <span class="title">
  484. <a href="LuCI.Response.html">LuCI.Response</a>
  485. </span>
  486. <ul class="members itemMembers">
  487. <span class="subtitle">Members</span>
  488. <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
  489. <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
  490. <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
  491. <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
  492. <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
  493. <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
  494. </ul>
  495. <ul class="typedefs itemMembers">
  496. </ul>
  497. <ul class="typedefs itemMembers">
  498. </ul>
  499. <ul class="methods itemMembers">
  500. <span class="subtitle">Methods</span>
  501. <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
  502. <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
  503. <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
  504. </ul>
  505. <ul class="events itemMembers">
  506. </ul>
  507. </li>
  508. <li class="item" data-name="LuCI.rpc">
  509. <span class="title">
  510. <a href="LuCI.rpc.html">LuCI.rpc</a>
  511. </span>
  512. <ul class="members itemMembers">
  513. </ul>
  514. <ul class="typedefs itemMembers">
  515. <span class="subtitle">Typedefs</span>
  516. <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
  517. <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
  518. <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
  519. <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
  520. </ul>
  521. <ul class="typedefs itemMembers">
  522. </ul>
  523. <ul class="methods itemMembers">
  524. <span class="subtitle">Methods</span>
  525. <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
  526. <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
  527. <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
  528. <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
  529. <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
  530. <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
  531. <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
  532. <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
  533. <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
  534. </ul>
  535. <ul class="events itemMembers">
  536. </ul>
  537. </li>
  538. <li class="item" data-name="LuCI.uci">
  539. <span class="title">
  540. <a href="LuCI.uci.html">LuCI.uci</a>
  541. </span>
  542. <ul class="members itemMembers">
  543. </ul>
  544. <ul class="typedefs itemMembers">
  545. <span class="subtitle">Typedefs</span>
  546. <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
  547. <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
  548. <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
  549. </ul>
  550. <ul class="typedefs itemMembers">
  551. </ul>
  552. <ul class="methods itemMembers">
  553. <span class="subtitle">Methods</span>
  554. <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
  555. <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
  556. <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
  557. <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
  558. <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
  559. <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
  560. <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
  561. <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
  562. <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
  563. <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
  564. <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
  565. <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
  566. <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
  567. <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
  568. <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
  569. <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
  570. <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
  571. </ul>
  572. <ul class="events itemMembers">
  573. </ul>
  574. </li>
  575. <li class="item" data-name="LuCI.view">
  576. <span class="title">
  577. <a href="LuCI.view.html">LuCI.view</a>
  578. </span>
  579. <ul class="members itemMembers">
  580. </ul>
  581. <ul class="typedefs itemMembers">
  582. </ul>
  583. <ul class="typedefs itemMembers">
  584. </ul>
  585. <ul class="methods itemMembers">
  586. <span class="subtitle">Methods</span>
  587. <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
  588. <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
  589. <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
  590. <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
  591. <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
  592. <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
  593. </ul>
  594. <ul class="events itemMembers">
  595. </ul>
  596. </li>
  597. <li class="item" data-name="LuCI.XHR">
  598. <span class="title">
  599. <a href="LuCI.XHR.html">LuCI.XHR</a>
  600. </span>
  601. <ul class="members itemMembers">
  602. </ul>
  603. <ul class="typedefs itemMembers">
  604. </ul>
  605. <ul class="typedefs itemMembers">
  606. </ul>
  607. <ul class="methods itemMembers">
  608. <span class="subtitle">Methods</span>
  609. <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
  610. <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
  611. <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
  612. <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
  613. <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
  614. <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
  615. </ul>
  616. <ul class="events itemMembers">
  617. </ul>
  618. </li>
  619. </ul>
  620. </div>
  621. <div class="main">
  622. <h1 class="page-title" data-filename="LuCI.fs.html">Class: fs</h1>
  623. <section>
  624. <header>
  625. <h2>
  626. <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span>
  627. fs
  628. </h2>
  629. <div class="class-description"><p>Provides high level utilities to wrap file system related RPC calls.
  630. To import the class in views, use <code>'require fs'</code>, to import it in
  631. external JavaScript, use <code>L.require(&quot;fs&quot;).then(...)</code>.</p></div>
  632. </header>
  633. <article>
  634. <div class="container-overview">
  635. <dt>
  636. <div class="nameContainer">
  637. <h4 class="name" id="fs">
  638. new LuCI.fs<span class="signature">()</span>
  639. </h4>
  640. <div class="tag-source">
  641. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line111">line 111</a>
  642. </div>
  643. </div>
  644. </dt>
  645. <dd>
  646. <dl class="details">
  647. </dl>
  648. </dd>
  649. </div>
  650. <h3 class="subsection-title">Methods</h3>
  651. <dl>
  652. <dt>
  653. <div class="nameContainer">
  654. <h4 class="name" id="exec">
  655. exec<span class="signature">(command, <span class="optional">params</span>, <span class="optional">env</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>>}</span>
  656. </h4>
  657. <div class="tag-source">
  658. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line232">line 232</a>
  659. </div>
  660. </div>
  661. </dt>
  662. <dd>
  663. <div class="description">
  664. <p>Execute the specified command, optionally passing params and
  665. environment variables.</p>
  666. <p>Note: The <code>command</code> must be either the path to an executable,
  667. or a basename without arguments in which case it will be searched
  668. in $PATH. If specified, the values given in <code>params</code> will be passed
  669. as arguments to the command.</p>
  670. <p>The key/value pairs in the optional <code>env</code> table are translated to
  671. <code>setenv()</code> calls prior to running the command.</p>
  672. </div>
  673. <table class="params">
  674. <thead>
  675. <tr>
  676. <th>Name</th>
  677. <th>Type</th>
  678. <th class="last">Description</th>
  679. </tr>
  680. </thead>
  681. <tbody>
  682. <tr>
  683. <td class="name"><code>command</code></td>
  684. <td class="type">
  685. <span class="param-type">string</span>
  686. </td>
  687. <td class="description last">
  688. <p>The command to invoke.</p></td>
  689. </tr>
  690. <tr>
  691. <td class="name"><code>params</code></td>
  692. <td class="type">
  693. <span class="param-type">Array.&lt;string></span>
  694. </td>
  695. <td class="description last">
  696. <span class="optional">optional</span>
  697. <p>The arguments to pass to the command.</p></td>
  698. </tr>
  699. <tr>
  700. <td class="name"><code>env</code></td>
  701. <td class="type">
  702. <span class="param-type">Object.&lt;string, string></span>
  703. </td>
  704. <td class="description last">
  705. <span class="optional">optional</span>
  706. <p>Environment variables to set.</p></td>
  707. </tr>
  708. </tbody>
  709. </table>
  710. <dl class="details">
  711. </dl>
  712. <h5>Returns:</h5>
  713. <table class="params">
  714. <thead>
  715. <tr>
  716. <th>Type</th>
  717. <th class="last">Description</th>
  718. </tr>
  719. </thead>
  720. <tbody>
  721. <tr>
  722. <td class="type">
  723. Promise.&lt;<a href="LuCI.fs.html#.FileExecResult">LuCI.fs.FileExecResult</a>>
  724. </td>
  725. <td class="description last">Returns a promise resolving to an object describing the execution
  726. results or rejecting with an error stating the failure reason.</td>
  727. </tr>
  728. </tbody>
  729. </table>
  730. </dd>
  731. <dt>
  732. <div class="nameContainer">
  733. <h4 class="name" id="lines">
  734. lines<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;string>>}</span>
  735. </h4>
  736. <div class="tag-source">
  737. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line281">line 281</a>
  738. </div>
  739. </div>
  740. </dt>
  741. <dd>
  742. <div class="description">
  743. <p>Read the contents of the given file, split it into lines, trim
  744. leading and trailing white space of each line and return the
  745. resulting array.</p>
  746. <p>This function is guaranteed to not reject its promises, on failure,
  747. an empty array will be returned.</p>
  748. </div>
  749. <table class="params">
  750. <thead>
  751. <tr>
  752. <th>Name</th>
  753. <th>Type</th>
  754. <th class="last">Description</th>
  755. </tr>
  756. </thead>
  757. <tbody>
  758. <tr>
  759. <td class="name"><code>path</code></td>
  760. <td class="type">
  761. <span class="param-type">string</span>
  762. </td>
  763. <td class="description last">
  764. <p>The file path to read.</p></td>
  765. </tr>
  766. </tbody>
  767. </table>
  768. <dl class="details">
  769. </dl>
  770. <h5>Returns:</h5>
  771. <table class="params">
  772. <thead>
  773. <tr>
  774. <th>Type</th>
  775. <th class="last">Description</th>
  776. </tr>
  777. </thead>
  778. <tbody>
  779. <tr>
  780. <td class="type">
  781. Promise.&lt;Array.&lt;string>>
  782. </td>
  783. <td class="description last">Returns a promise resolving to an array containing the stripped lines
  784. of the given file or <code>[]</code> on failure.</td>
  785. </tr>
  786. </tbody>
  787. </table>
  788. </dd>
  789. <dt>
  790. <div class="nameContainer">
  791. <h4 class="name" id="list">
  792. list<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;Array.&lt;<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>>}</span>
  793. </h4>
  794. <div class="tag-source">
  795. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line132">line 132</a>
  796. </div>
  797. </div>
  798. </dt>
  799. <dd>
  800. <div class="description">
  801. <p>Obtains a listing of the specified directory.</p>
  802. </div>
  803. <table class="params">
  804. <thead>
  805. <tr>
  806. <th>Name</th>
  807. <th>Type</th>
  808. <th class="last">Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td class="name"><code>path</code></td>
  814. <td class="type">
  815. <span class="param-type">string</span>
  816. </td>
  817. <td class="description last">
  818. <p>The directory path to list.</p></td>
  819. </tr>
  820. </tbody>
  821. </table>
  822. <dl class="details">
  823. </dl>
  824. <h5>Returns:</h5>
  825. <table class="params">
  826. <thead>
  827. <tr>
  828. <th>Type</th>
  829. <th class="last">Description</th>
  830. </tr>
  831. </thead>
  832. <tbody>
  833. <tr>
  834. <td class="type">
  835. Promise.&lt;Array.&lt;<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>>
  836. </td>
  837. <td class="description last">Returns a promise resolving to an array of stat detail objects or
  838. rejecting with an error stating the failure reason.</td>
  839. </tr>
  840. </tbody>
  841. </table>
  842. </dd>
  843. <dt>
  844. <div class="nameContainer">
  845. <h4 class="name" id="read">
  846. read<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;string>}</span>
  847. </h4>
  848. <div class="tag-source">
  849. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line161">line 161</a>
  850. </div>
  851. </div>
  852. </dt>
  853. <dd>
  854. <div class="description">
  855. <p>Read the contents of the given file and return them.
  856. Note: this function is unsuitable for obtaining binary data.</p>
  857. </div>
  858. <table class="params">
  859. <thead>
  860. <tr>
  861. <th>Name</th>
  862. <th>Type</th>
  863. <th class="last">Description</th>
  864. </tr>
  865. </thead>
  866. <tbody>
  867. <tr>
  868. <td class="name"><code>path</code></td>
  869. <td class="type">
  870. <span class="param-type">string</span>
  871. </td>
  872. <td class="description last">
  873. <p>The file path to read.</p></td>
  874. </tr>
  875. </tbody>
  876. </table>
  877. <dl class="details">
  878. </dl>
  879. <h5>Returns:</h5>
  880. <table class="params">
  881. <thead>
  882. <tr>
  883. <th>Type</th>
  884. <th class="last">Description</th>
  885. </tr>
  886. </thead>
  887. <tbody>
  888. <tr>
  889. <td class="type">
  890. Promise.&lt;string>
  891. </td>
  892. <td class="description last">Returns a promise resolving to a string containing the file contents or
  893. rejecting with an error stating the failure reason.</td>
  894. </tr>
  895. </tbody>
  896. </table>
  897. </dd>
  898. <dt>
  899. <div class="nameContainer">
  900. <h4 class="name" id="remove">
  901. remove<span class="signature">(The)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;number>}</span>
  902. </h4>
  903. <div class="tag-source">
  904. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line203">line 203</a>
  905. </div>
  906. </div>
  907. </dt>
  908. <dd>
  909. <div class="description">
  910. <p>Unlink the given file.</p>
  911. </div>
  912. <table class="params">
  913. <thead>
  914. <tr>
  915. <th>Name</th>
  916. <th>Type</th>
  917. <th class="last">Description</th>
  918. </tr>
  919. </thead>
  920. <tbody>
  921. <tr>
  922. <td class="name"><code>The</code></td>
  923. <td class="type">
  924. <span class="param-type">string</span>
  925. </td>
  926. <td class="description last">
  927. <p>file path to remove.</p></td>
  928. </tr>
  929. </tbody>
  930. </table>
  931. <dl class="details">
  932. </dl>
  933. <h5>Returns:</h5>
  934. <table class="params">
  935. <thead>
  936. <tr>
  937. <th>Type</th>
  938. <th class="last">Description</th>
  939. </tr>
  940. </thead>
  941. <tbody>
  942. <tr>
  943. <td class="type">
  944. Promise.&lt;number>
  945. </td>
  946. <td class="description last">Returns a promise resolving to <code>0</code> or rejecting with an error stating
  947. the failure reason.</td>
  948. </tr>
  949. </tbody>
  950. </table>
  951. </dd>
  952. <dt>
  953. <div class="nameContainer">
  954. <h4 class="name" id="stat">
  955. stat<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>}</span>
  956. </h4>
  957. <div class="tag-source">
  958. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line146">line 146</a>
  959. </div>
  960. </div>
  961. </dt>
  962. <dd>
  963. <div class="description">
  964. <p>Return file stat information on the specified path.</p>
  965. </div>
  966. <table class="params">
  967. <thead>
  968. <tr>
  969. <th>Name</th>
  970. <th>Type</th>
  971. <th class="last">Description</th>
  972. </tr>
  973. </thead>
  974. <tbody>
  975. <tr>
  976. <td class="name"><code>path</code></td>
  977. <td class="type">
  978. <span class="param-type">string</span>
  979. </td>
  980. <td class="description last">
  981. <p>The filesystem path to stat.</p></td>
  982. </tr>
  983. </tbody>
  984. </table>
  985. <dl class="details">
  986. </dl>
  987. <h5>Returns:</h5>
  988. <table class="params">
  989. <thead>
  990. <tr>
  991. <th>Type</th>
  992. <th class="last">Description</th>
  993. </tr>
  994. </thead>
  995. <tbody>
  996. <tr>
  997. <td class="type">
  998. Promise.&lt;<a href="LuCI.fs.html#.FileStatEntry">LuCI.fs.FileStatEntry</a>>
  999. </td>
  1000. <td class="description last">Returns a promise resolving to a stat detail object or
  1001. rejecting with an error stating the failure reason.</td>
  1002. </tr>
  1003. </tbody>
  1004. </table>
  1005. </dd>
  1006. <dt>
  1007. <div class="nameContainer">
  1008. <h4 class="name" id="trimmed">
  1009. trimmed<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;string>}</span>
  1010. </h4>
  1011. <div class="tag-source">
  1012. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line260">line 260</a>
  1013. </div>
  1014. </div>
  1015. </dt>
  1016. <dd>
  1017. <div class="description">
  1018. <p>Read the contents of the given file, trim leading and trailing white
  1019. space and return the trimmed result. In case of errors, return an empty
  1020. string instead.</p>
  1021. <p>Note: this function is useful to read single-value files in <code>/sys</code>
  1022. or <code>/proc</code>.</p>
  1023. <p>This function is guaranteed to not reject its promises, on failure,
  1024. an empty string will be returned.</p>
  1025. </div>
  1026. <table class="params">
  1027. <thead>
  1028. <tr>
  1029. <th>Name</th>
  1030. <th>Type</th>
  1031. <th class="last">Description</th>
  1032. </tr>
  1033. </thead>
  1034. <tbody>
  1035. <tr>
  1036. <td class="name"><code>path</code></td>
  1037. <td class="type">
  1038. <span class="param-type">string</span>
  1039. </td>
  1040. <td class="description last">
  1041. <p>The file path to read.</p></td>
  1042. </tr>
  1043. </tbody>
  1044. </table>
  1045. <dl class="details">
  1046. </dl>
  1047. <h5>Returns:</h5>
  1048. <table class="params">
  1049. <thead>
  1050. <tr>
  1051. <th>Type</th>
  1052. <th class="last">Description</th>
  1053. </tr>
  1054. </thead>
  1055. <tbody>
  1056. <tr>
  1057. <td class="type">
  1058. Promise.&lt;string>
  1059. </td>
  1060. <td class="description last">Returns a promise resolving to the file contents or the empty string
  1061. on failure.</td>
  1062. </tr>
  1063. </tbody>
  1064. </table>
  1065. </dd>
  1066. <dt>
  1067. <div class="nameContainer">
  1068. <h4 class="name" id="write">
  1069. write<span class="signature">(path, <span class="optional">data</span>, <span class="optional">mode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;number>}</span>
  1070. </h4>
  1071. <div class="tag-source">
  1072. <a href="fs.js.html">fs.js</a>, <a href="fs.js.html#line187">line 187</a>
  1073. </div>
  1074. </div>
  1075. </dt>
  1076. <dd>
  1077. <div class="description">
  1078. <p>Write the given data to the specified file path.
  1079. If the specified file path does not exist, it will be created, given
  1080. sufficient permissions.</p>
  1081. <p>Note: <code>data</code> will be converted to a string using <code>String(data)</code> or to
  1082. <code>''</code> when it is <code>null</code>.</p>
  1083. </div>
  1084. <table class="params">
  1085. <thead>
  1086. <tr>
  1087. <th>Name</th>
  1088. <th>Type</th>
  1089. <th class="last">Description</th>
  1090. </tr>
  1091. </thead>
  1092. <tbody>
  1093. <tr>
  1094. <td class="name"><code>path</code></td>
  1095. <td class="type">
  1096. <span class="param-type">string</span>
  1097. </td>
  1098. <td class="description last">
  1099. <p>The file path to write to.</p></td>
  1100. </tr>
  1101. <tr>
  1102. <td class="name"><code>data</code></td>
  1103. <td class="type">
  1104. <span class="param-type">*</span>
  1105. </td>
  1106. <td class="description last">
  1107. <span class="optional">optional</span>
  1108. <p>The file data to write. If it is null, it will be set to an empty
  1109. string.</p></td>
  1110. </tr>
  1111. <tr>
  1112. <td class="name"><code>mode</code></td>
  1113. <td class="type">
  1114. <span class="param-type">number</span>
  1115. </td>
  1116. <td class="description last">
  1117. <span class="optional">optional</span>
  1118. <p>The permissions to use on file creation. Default is 420 (0644).</p></td>
  1119. </tr>
  1120. </tbody>
  1121. </table>
  1122. <dl class="details">
  1123. </dl>
  1124. <h5>Returns:</h5>
  1125. <table class="params">
  1126. <thead>
  1127. <tr>
  1128. <th>Type</th>
  1129. <th class="last">Description</th>
  1130. </tr>
  1131. </thead>
  1132. <tbody>
  1133. <tr>
  1134. <td class="type">
  1135. Promise.&lt;number>
  1136. </td>
  1137. <td class="description last">Returns a promise resolving to <code>0</code> or rejecting with an error stating
  1138. the failure reason.</td>
  1139. </tr>
  1140. </tbody>
  1141. </table>
  1142. </dd>
  1143. </dl>
  1144. <h3 class="subsection-title">Type Definitions</h3>
  1145. <dl>
  1146. <dt>
  1147. <div class="nameContainer">
  1148. <h4 class="name" id=".FileExecResult">LuCI.fs.FileExecResult<span class="type-signature type object">Object</span> </h4>
  1149. </div>
  1150. </dt>
  1151. <dd>
  1152. <dl class="details">
  1153. <h5 class="subsection-title">Properties:</h5>
  1154. <dl>
  1155. <table class="props">
  1156. <thead>
  1157. <tr>
  1158. <th>Name</th>
  1159. <th>Type</th>
  1160. <th>Argument</th>
  1161. <th class="last">Description</th>
  1162. </tr>
  1163. </thead>
  1164. <tbody>
  1165. <tr>
  1166. <td class="name"><code>code</code></td>
  1167. <td class="type">
  1168. <span class="param-type">number</span>
  1169. </td>
  1170. <td class="attributes">
  1171. </td>
  1172. <td class="description last"><p>The exit code of the invoked command</p></td>
  1173. </tr>
  1174. <tr>
  1175. <td class="name"><code>stdout</code></td>
  1176. <td class="type">
  1177. <span class="param-type">string</span>
  1178. </td>
  1179. <td class="attributes">
  1180. &lt;optional><br>
  1181. </td>
  1182. <td class="description last"><p>The stdout produced by the command, if any</p></td>
  1183. </tr>
  1184. <tr>
  1185. <td class="name"><code>stderr</code></td>
  1186. <td class="type">
  1187. <span class="param-type">string</span>
  1188. </td>
  1189. <td class="attributes">
  1190. &lt;optional><br>
  1191. </td>
  1192. <td class="description last"><p>The stderr produced by the command, if any</p></td>
  1193. </tr>
  1194. </tbody>
  1195. </table></dl>
  1196. </dl>
  1197. </dd>
  1198. <dt>
  1199. <div class="nameContainer">
  1200. <h4 class="name" id=".FileStatEntry">LuCI.fs.FileStatEntry<span class="type-signature type object">Object</span> </h4>
  1201. </div>
  1202. </dt>
  1203. <dd>
  1204. <dl class="details">
  1205. <h5 class="subsection-title">Properties:</h5>
  1206. <dl>
  1207. <table class="props">
  1208. <thead>
  1209. <tr>
  1210. <th>Name</th>
  1211. <th>Type</th>
  1212. <th class="last">Description</th>
  1213. </tr>
  1214. </thead>
  1215. <tbody>
  1216. <tr>
  1217. <td class="name"><code>name</code></td>
  1218. <td class="type">
  1219. <span class="param-type">string</span>
  1220. </td>
  1221. <td class="description last"><p>Name of the directory entry</p></td>
  1222. </tr>
  1223. <tr>
  1224. <td class="name"><code>type</code></td>
  1225. <td class="type">
  1226. <span class="param-type">string</span>
  1227. </td>
  1228. <td class="description last"><p>Type of the entry, one of <code>block</code>, <code>char</code>, <code>directory</code>, <code>fifo</code>, <code>symlink</code>, <code>file</code>, <code>socket</code> or <code>unknown</code></p></td>
  1229. </tr>
  1230. <tr>
  1231. <td class="name"><code>size</code></td>
  1232. <td class="type">
  1233. <span class="param-type">number</span>
  1234. </td>
  1235. <td class="description last"><p>Size in bytes</p></td>
  1236. </tr>
  1237. <tr>
  1238. <td class="name"><code>mode</code></td>
  1239. <td class="type">
  1240. <span class="param-type">number</span>
  1241. </td>
  1242. <td class="description last"><p>Access permissions</p></td>
  1243. </tr>
  1244. <tr>
  1245. <td class="name"><code>atime</code></td>
  1246. <td class="type">
  1247. <span class="param-type">number</span>
  1248. </td>
  1249. <td class="description last"><p>Last access time in seconds since epoch</p></td>
  1250. </tr>
  1251. <tr>
  1252. <td class="name"><code>mtime</code></td>
  1253. <td class="type">
  1254. <span class="param-type">number</span>
  1255. </td>
  1256. <td class="description last"><p>Last modification time in seconds since epoch</p></td>
  1257. </tr>
  1258. <tr>
  1259. <td class="name"><code>ctime</code></td>
  1260. <td class="type">
  1261. <span class="param-type">number</span>
  1262. </td>
  1263. <td class="description last"><p>Last change time in seconds since epoch</p></td>
  1264. </tr>
  1265. <tr>
  1266. <td class="name"><code>inode</code></td>
  1267. <td class="type">
  1268. <span class="param-type">number</span>
  1269. </td>
  1270. <td class="description last"><p>Inode number</p></td>
  1271. </tr>
  1272. <tr>
  1273. <td class="name"><code>uid</code></td>
  1274. <td class="type">
  1275. <span class="param-type">number</span>
  1276. </td>
  1277. <td class="description last"><p>Numeric owner id</p></td>
  1278. </tr>
  1279. <tr>
  1280. <td class="name"><code>gid</code></td>
  1281. <td class="type">
  1282. <span class="param-type">number</span>
  1283. </td>
  1284. <td class="description last"><p>Numeric group id</p></td>
  1285. </tr>
  1286. </tbody>
  1287. </table></dl>
  1288. </dl>
  1289. </dd>
  1290. </dl>
  1291. </article>
  1292. </section>
  1293. <footer>
  1294. Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:06 GMT+0100 (Central European Standard Time)
  1295. </footer>
  1296. </div>
  1297. </div>
  1298. <script>prettyPrint();</script>
  1299. <script src="scripts/jaguar.js"></script>
  1300. </body>
  1301. </html>