module-barejs_polyfill.Array.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Array</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Array</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>
  20. <span class="ancestors"><a href="module-barejs_polyfill.html">barejs/polyfill</a>.</span>Array<span class="signature">()</span><span class="type-signature"></span></h2>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h4 class="name" id="Array"><span class="type-signature"></span>new Array<span class="signature">()</span><span class="type-signature"></span></h4>
  25. <div class="description">
  26. <p>Polyfills for <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>.</p>
  27. </div>
  28. <dl class="details">
  29. <dt class="tag-source">Source:</dt>
  30. <dd class="tag-source"><ul class="dummy"><li>
  31. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line48">line 48</a>
  32. </li></ul></dd>
  33. </dl>
  34. </div>
  35. <h3 class="subsection-title">Methods</h3>
  36. <h4 class="name" id=".from"><span class="type-signature">(static) </span>from<span class="signature">(_arrayLike, _mapFn<span class="signature-attributes">opt</span>, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array}</span></h4>
  37. <div class="description">
  38. <p>The Array.from() method creates a new Array instance from an array-like or iterable object.</p>
  39. </div>
  40. <h5>Parameters:</h5>
  41. <table class="params">
  42. <thead>
  43. <tr>
  44. <th>Name</th>
  45. <th>Type</th>
  46. <th>Attributes</th>
  47. <th class="last">Description</th>
  48. </tr>
  49. </thead>
  50. <tbody>
  51. <tr>
  52. <td class="name"><code>_arrayLike</code></td>
  53. <td class="type">
  54. <span class="param-type">object</span>
  55. </td>
  56. <td class="attributes">
  57. </td>
  58. <td class="description last"><p>An array-like or iterable object to convert to an array.</p></td>
  59. </tr>
  60. <tr>
  61. <td class="name"><code>_mapFn</code></td>
  62. <td class="type">
  63. <span class="param-type">function</span>
  64. </td>
  65. <td class="attributes">
  66. &lt;optional><br>
  67. </td>
  68. <td class="description last"><p>Optional. Map function to call on every element of the array.</p></td>
  69. </tr>
  70. <tr>
  71. <td class="name"><code>_thisArg</code></td>
  72. <td class="type">
  73. <span class="param-type">object</span>
  74. </td>
  75. <td class="attributes">
  76. &lt;optional><br>
  77. </td>
  78. <td class="description last"><p>Optional. Value to use as this when executing mapFn.</p></td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. <dl class="details">
  83. <dt class="tag-source">Source:</dt>
  84. <dd class="tag-source"><ul class="dummy"><li>
  85. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line399">line 399</a>
  86. </li></ul></dd>
  87. </dl>
  88. <h5>Returns:</h5>
  89. <div class="param-desc">
  90. <p>The created Array.</p>
  91. </div>
  92. <dl>
  93. <dt>
  94. Type
  95. </dt>
  96. <dd>
  97. <span class="param-type">Array</span>
  98. </dd>
  99. </dl>
  100. <h4 class="name" id=".isArray"><span class="type-signature">(static) </span>isArray<span class="signature">(_arg)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  101. <div class="description">
  102. <p>Check if an object is an array.</p>
  103. </div>
  104. <h5>Parameters:</h5>
  105. <table class="params">
  106. <thead>
  107. <tr>
  108. <th>Name</th>
  109. <th>Type</th>
  110. <th class="last">Description</th>
  111. </tr>
  112. </thead>
  113. <tbody>
  114. <tr>
  115. <td class="name"><code>_arg</code></td>
  116. <td class="type">
  117. </td>
  118. <td class="description last"><p>The object to check.</p></td>
  119. </tr>
  120. </tbody>
  121. </table>
  122. <dl class="details">
  123. <dt class="tag-source">Source:</dt>
  124. <dd class="tag-source"><ul class="dummy"><li>
  125. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line296">line 296</a>
  126. </li></ul></dd>
  127. </dl>
  128. <h5>Returns:</h5>
  129. <div class="param-desc">
  130. <p>true if an object is an array, false if it is not.</p>
  131. </div>
  132. <dl>
  133. <dt>
  134. Type
  135. </dt>
  136. <dd>
  137. <span class="param-type">boolean</span>
  138. </dd>
  139. </dl>
  140. <h4 class="name" id=".of"><span class="type-signature">(static) </span>of<span class="signature">(&hellip;_value)</span><span class="type-signature"> &rarr; {Array}</span></h4>
  141. <div class="description">
  142. <p>The Array.of() method creates a new Array instance with a variable number of arguments,
  143. regardless of number or type of the arguments.</p>
  144. </div>
  145. <h5>Parameters:</h5>
  146. <table class="params">
  147. <thead>
  148. <tr>
  149. <th>Name</th>
  150. <th>Type</th>
  151. <th>Attributes</th>
  152. <th class="last">Description</th>
  153. </tr>
  154. </thead>
  155. <tbody>
  156. <tr>
  157. <td class="name"><code>_value</code></td>
  158. <td class="type">
  159. <span class="param-type">any</span>
  160. </td>
  161. <td class="attributes">
  162. &lt;repeatable><br>
  163. </td>
  164. <td class="description last"><p>Any number of values that will be the content of the array.</p></td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <dl class="details">
  169. <dt class="tag-source">Source:</dt>
  170. <dd class="tag-source"><ul class="dummy"><li>
  171. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line381">line 381</a>
  172. </li></ul></dd>
  173. </dl>
  174. <h5>Returns:</h5>
  175. <div class="param-desc">
  176. <p>The created Array.</p>
  177. </div>
  178. <dl>
  179. <dt>
  180. Type
  181. </dt>
  182. <dd>
  183. <span class="param-type">Array</span>
  184. </dd>
  185. </dl>
  186. <h4 class="name" id="every"><span class="type-signature"></span>every<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  187. <div class="description">
  188. <p>Check if callback returns true for every element</p>
  189. </div>
  190. <h5>This:</h5>
  191. <ul><li>{Array}</li></ul>
  192. <h5>Parameters:</h5>
  193. <table class="params">
  194. <thead>
  195. <tr>
  196. <th>Name</th>
  197. <th>Type</th>
  198. <th>Attributes</th>
  199. <th class="last">Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td class="name"><code>_callback</code></td>
  205. <td class="type">
  206. <span class="param-type">function</span>
  207. </td>
  208. <td class="attributes">
  209. </td>
  210. <td class="description last"><p>The callback to test each value</p></td>
  211. </tr>
  212. <tr>
  213. <td class="name"><code>_thisArg</code></td>
  214. <td class="type">
  215. <span class="param-type">object</span>
  216. </td>
  217. <td class="attributes">
  218. &lt;optional><br>
  219. </td>
  220. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  221. </tr>
  222. </tbody>
  223. </table>
  224. <dl class="details">
  225. <dt class="tag-source">Source:</dt>
  226. <dd class="tag-source"><ul class="dummy"><li>
  227. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line74">line 74</a>
  228. </li></ul></dd>
  229. </dl>
  230. <h5>Returns:</h5>
  231. <div class="param-desc">
  232. <p>True if the callback returns true for each element, false otherwise.</p>
  233. </div>
  234. <dl>
  235. <dt>
  236. Type
  237. </dt>
  238. <dd>
  239. <span class="param-type">boolean</span>
  240. </dd>
  241. </dl>
  242. <h4 class="name" id="fill"><span class="type-signature"></span>fill<span class="signature">(_value, _start<span class="signature-attributes">opt</span>, _end<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  243. <div class="description">
  244. <p>The fill() method fills all the elements of an array from a start index to an end index with a static value.</p>
  245. </div>
  246. <h5>Parameters:</h5>
  247. <table class="params">
  248. <thead>
  249. <tr>
  250. <th>Name</th>
  251. <th>Type</th>
  252. <th>Attributes</th>
  253. <th>Default</th>
  254. <th class="last">Description</th>
  255. </tr>
  256. </thead>
  257. <tbody>
  258. <tr>
  259. <td class="name"><code>_value</code></td>
  260. <td class="type">
  261. </td>
  262. <td class="attributes">
  263. </td>
  264. <td class="default">
  265. </td>
  266. <td class="description last"><p>The value to set to each index</p></td>
  267. </tr>
  268. <tr>
  269. <td class="name"><code>_start</code></td>
  270. <td class="type">
  271. <span class="param-type">number</span>
  272. </td>
  273. <td class="attributes">
  274. &lt;optional><br>
  275. </td>
  276. <td class="default">
  277. 0
  278. </td>
  279. <td class="description last"><p>Optional: the index to start filling (inclusive)
  280. If _start is negative, it is treated as length + _start.</p></td>
  281. </tr>
  282. <tr>
  283. <td class="name"><code>_end</code></td>
  284. <td class="type">
  285. <span class="param-type">number</span>
  286. </td>
  287. <td class="attributes">
  288. &lt;optional><br>
  289. </td>
  290. <td class="default">
  291. </td>
  292. <td class="description last"><p>Optional: the index at which to stop filling (exclusive)
  293. If _end is negative, it is treated as length + _end.</p></td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <dl class="details">
  298. <dt class="tag-source">Source:</dt>
  299. <dd class="tag-source"><ul class="dummy"><li>
  300. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line358">line 358</a>
  301. </li></ul></dd>
  302. </dl>
  303. <h4 class="name" id="filter"><span class="type-signature"></span>filter<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array}</span></h4>
  304. <div class="description">
  305. <p>Creates a new array with only the elements matching the provided function.</p>
  306. </div>
  307. <h5>This:</h5>
  308. <ul><li>{Array}</li></ul>
  309. <h5>Parameters:</h5>
  310. <table class="params">
  311. <thead>
  312. <tr>
  313. <th>Name</th>
  314. <th>Type</th>
  315. <th>Attributes</th>
  316. <th class="last">Description</th>
  317. </tr>
  318. </thead>
  319. <tbody>
  320. <tr>
  321. <td class="name"><code>_callback</code></td>
  322. <td class="type">
  323. <span class="param-type">function</span>
  324. </td>
  325. <td class="attributes">
  326. </td>
  327. <td class="description last"><p>The callback to test each value.</p></td>
  328. </tr>
  329. <tr>
  330. <td class="name"><code>_thisArg</code></td>
  331. <td class="type">
  332. <span class="param-type">object</span>
  333. </td>
  334. <td class="attributes">
  335. &lt;optional><br>
  336. </td>
  337. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  338. </tr>
  339. </tbody>
  340. </table>
  341. <dl class="details">
  342. <dt class="tag-source">Source:</dt>
  343. <dd class="tag-source"><ul class="dummy"><li>
  344. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line117">line 117</a>
  345. </li></ul></dd>
  346. </dl>
  347. <h5>Returns:</h5>
  348. <div class="param-desc">
  349. <p>A new array containing the result of callback per element.</p>
  350. </div>
  351. <dl>
  352. <dt>
  353. Type
  354. </dt>
  355. <dd>
  356. <span class="param-type">Array</span>
  357. </dd>
  358. </dl>
  359. <h4 class="name" id="find"><span class="type-signature"></span>find<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  360. <div class="description">
  361. <p>Find a value in the array</p>
  362. </div>
  363. <h5>Parameters:</h5>
  364. <table class="params">
  365. <thead>
  366. <tr>
  367. <th>Name</th>
  368. <th>Type</th>
  369. <th>Attributes</th>
  370. <th class="last">Description</th>
  371. </tr>
  372. </thead>
  373. <tbody>
  374. <tr>
  375. <td class="name"><code>_callback</code></td>
  376. <td class="type">
  377. <span class="param-type">function</span>
  378. </td>
  379. <td class="attributes">
  380. </td>
  381. <td class="description last"><p>The callback to test each value in the array. If the value matches, it should return true.</p></td>
  382. </tr>
  383. <tr>
  384. <td class="name"><code>_thisArg</code></td>
  385. <td class="type">
  386. <span class="param-type">object</span>
  387. </td>
  388. <td class="attributes">
  389. &lt;optional><br>
  390. </td>
  391. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  392. </tr>
  393. </tbody>
  394. </table>
  395. <dl class="details">
  396. <dt class="tag-source">Source:</dt>
  397. <dd class="tag-source"><ul class="dummy"><li>
  398. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line312">line 312</a>
  399. </li></ul></dd>
  400. </dl>
  401. <h5>Returns:</h5>
  402. <div class="param-desc">
  403. <p>the found value or undefined if not found.</p>
  404. </div>
  405. <h4 class="name" id="findIndex"><span class="type-signature"></span>findIndex<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
  406. <div class="description">
  407. <p>Find a value in the array</p>
  408. </div>
  409. <h5>Parameters:</h5>
  410. <table class="params">
  411. <thead>
  412. <tr>
  413. <th>Name</th>
  414. <th>Type</th>
  415. <th>Attributes</th>
  416. <th class="last">Description</th>
  417. </tr>
  418. </thead>
  419. <tbody>
  420. <tr>
  421. <td class="name"><code>_callback</code></td>
  422. <td class="type">
  423. <span class="param-type">function</span>
  424. </td>
  425. <td class="attributes">
  426. </td>
  427. <td class="description last"><p>The callback to test each value in the array. If the value matches, it should return true.</p></td>
  428. </tr>
  429. <tr>
  430. <td class="name"><code>_thisArg</code></td>
  431. <td class="type">
  432. <span class="param-type">object</span>
  433. </td>
  434. <td class="attributes">
  435. &lt;optional><br>
  436. </td>
  437. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <dl class="details">
  442. <dt class="tag-source">Source:</dt>
  443. <dd class="tag-source"><ul class="dummy"><li>
  444. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line334">line 334</a>
  445. </li></ul></dd>
  446. </dl>
  447. <h5>Returns:</h5>
  448. <div class="param-desc">
  449. <p>the found index or -1 if not found.</p>
  450. </div>
  451. <dl>
  452. <dt>
  453. Type
  454. </dt>
  455. <dd>
  456. <span class="param-type">number</span>
  457. </dd>
  458. </dl>
  459. <h4 class="name" id="forEach"><span class="type-signature"></span>forEach<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  460. <div class="description">
  461. <p>Enumerate all values in the array</p>
  462. </div>
  463. <h5>This:</h5>
  464. <ul><li>{Array}</li></ul>
  465. <h5>Parameters:</h5>
  466. <table class="params">
  467. <thead>
  468. <tr>
  469. <th>Name</th>
  470. <th>Type</th>
  471. <th>Attributes</th>
  472. <th class="last">Description</th>
  473. </tr>
  474. </thead>
  475. <tbody>
  476. <tr>
  477. <td class="name"><code>_callback</code></td>
  478. <td class="type">
  479. <span class="param-type">function</span>
  480. </td>
  481. <td class="attributes">
  482. </td>
  483. <td class="description last"><p>The callback to call for each value</p></td>
  484. </tr>
  485. <tr>
  486. <td class="name"><code>_thisArg</code></td>
  487. <td class="type">
  488. <span class="param-type">object</span>
  489. </td>
  490. <td class="attributes">
  491. &lt;optional><br>
  492. </td>
  493. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  494. </tr>
  495. </tbody>
  496. </table>
  497. <dl class="details">
  498. <dt class="tag-source">Source:</dt>
  499. <dd class="tag-source"><ul class="dummy"><li>
  500. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line62">line 62</a>
  501. </li></ul></dd>
  502. </dl>
  503. <h4 class="name" id="includes"><span class="type-signature"></span>includes<span class="signature">(_searchElement, _fromIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  504. <div class="description">
  505. <p>The includes() method determines whether an array includes a certain element, returning true or false as appropriate.
  506. The array is searched forwards, starting at fromIndex (defaults to 0).</p>
  507. </div>
  508. <h5>Parameters:</h5>
  509. <table class="params">
  510. <thead>
  511. <tr>
  512. <th>Name</th>
  513. <th>Type</th>
  514. <th>Attributes</th>
  515. <th>Default</th>
  516. <th class="last">Description</th>
  517. </tr>
  518. </thead>
  519. <tbody>
  520. <tr>
  521. <td class="name"><code>_searchElement</code></td>
  522. <td class="type">
  523. <span class="param-type">object</span>
  524. </td>
  525. <td class="attributes">
  526. </td>
  527. <td class="default">
  528. </td>
  529. <td class="description last"><p>Element to locate in the array.</p></td>
  530. </tr>
  531. <tr>
  532. <td class="name"><code>_fromIndex</code></td>
  533. <td class="type">
  534. <span class="param-type">object</span>
  535. </td>
  536. <td class="attributes">
  537. &lt;optional><br>
  538. </td>
  539. <td class="default">
  540. 0
  541. </td>
  542. <td class="description last"><p>Optional: The index to start the search at. Default: 0
  543. If the index is greater than or equal to the array's length, -1 is returned, which means
  544. the array will not be searched. If the provided index value is a negative number, it is
  545. taken as the offset from the end of the array. Note: if the provided index is negative,
  546. the array is still searched from front to back. If the calculated index is less than 0,
  547. then the whole array will be searched.</p></td>
  548. </tr>
  549. </tbody>
  550. </table>
  551. <dl class="details">
  552. <dt class="tag-source">Source:</dt>
  553. <dd class="tag-source"><ul class="dummy"><li>
  554. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line490">line 490</a>
  555. </li></ul></dd>
  556. </dl>
  557. <h5>Returns:</h5>
  558. <div class="param-desc">
  559. <p>True if the element was found, false otherwise.</p>
  560. </div>
  561. <dl>
  562. <dt>
  563. Type
  564. </dt>
  565. <dd>
  566. <span class="param-type">boolean</span>
  567. </dd>
  568. </dl>
  569. <h4 class="name" id="indexOf"><span class="type-signature"></span>indexOf<span class="signature">(_searchElement, _fromIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
  570. <div class="description">
  571. <p>Returns the first index at which a given element can be found in the array, or -1 if it is not present.</p>
  572. </div>
  573. <h5>This:</h5>
  574. <ul><li>{Array}</li></ul>
  575. <h5>Parameters:</h5>
  576. <table class="params">
  577. <thead>
  578. <tr>
  579. <th>Name</th>
  580. <th>Type</th>
  581. <th>Attributes</th>
  582. <th>Default</th>
  583. <th class="last">Description</th>
  584. </tr>
  585. </thead>
  586. <tbody>
  587. <tr>
  588. <td class="name"><code>_searchElement</code></td>
  589. <td class="type">
  590. <span class="param-type">object</span>
  591. </td>
  592. <td class="attributes">
  593. </td>
  594. <td class="default">
  595. </td>
  596. <td class="description last"><p>Element to locate in the array.</p></td>
  597. </tr>
  598. <tr>
  599. <td class="name"><code>_fromIndex</code></td>
  600. <td class="type">
  601. <span class="param-type">number</span>
  602. </td>
  603. <td class="attributes">
  604. &lt;optional><br>
  605. </td>
  606. <td class="default">
  607. 0
  608. </td>
  609. <td class="description last"><p>Optional: The index to start the search at. Default: 0
  610. If the index is greater than or equal to the array's length, -1 is returned, which means
  611. the array will not be searched. If the provided index value is a negative number, it is
  612. taken as the offset from the end of the array. Note: if the provided index is negative,
  613. the array is still searched from front to back. If the calculated index is less than 0,
  614. then the whole array will be searched.</p></td>
  615. </tr>
  616. </tbody>
  617. </table>
  618. <dl class="details">
  619. <dt class="tag-source">Source:</dt>
  620. <dd class="tag-source"><ul class="dummy"><li>
  621. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line158">line 158</a>
  622. </li></ul></dd>
  623. </dl>
  624. <h5>Returns:</h5>
  625. <div class="param-desc">
  626. <p>The first index at which a given element can be found in the array, or -1 if it is not present.</p>
  627. </div>
  628. <dl>
  629. <dt>
  630. Type
  631. </dt>
  632. <dd>
  633. <span class="param-type">number</span>
  634. </dd>
  635. </dl>
  636. <h4 class="name" id="lastIndexOf"><span class="type-signature"></span>lastIndexOf<span class="signature">(_searchElement, _fromIndex<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
  637. <div class="description">
  638. <p>Returns the last index at which a given element can be found in the array, or -1 if it is not present.
  639. The array is searched backwards, starting at fromIndex.</p>
  640. </div>
  641. <h5>This:</h5>
  642. <ul><li>{Array}</li></ul>
  643. <h5>Parameters:</h5>
  644. <table class="params">
  645. <thead>
  646. <tr>
  647. <th>Name</th>
  648. <th>Type</th>
  649. <th>Attributes</th>
  650. <th>Default</th>
  651. <th class="last">Description</th>
  652. </tr>
  653. </thead>
  654. <tbody>
  655. <tr>
  656. <td class="name"><code>_searchElement</code></td>
  657. <td class="type">
  658. <span class="param-type">object</span>
  659. </td>
  660. <td class="attributes">
  661. </td>
  662. <td class="default">
  663. </td>
  664. <td class="description last"><p>Element to locate in the array.</p></td>
  665. </tr>
  666. <tr>
  667. <td class="name"><code>_fromIndex</code></td>
  668. <td class="type">
  669. <span class="param-type">number</span>
  670. </td>
  671. <td class="attributes">
  672. &lt;optional><br>
  673. </td>
  674. <td class="default">
  675. -1
  676. </td>
  677. <td class="description last"><p>Optional: The index at which to start searching backwards.
  678. Defaults to the array's length - 1, i.e. the whole array will be searched. If the index is
  679. greater than or equal to the length of the array, the whole array will be searched.
  680. If negative, it is taken as the offset from the end of the array. Note that even when
  681. the index is negative, the array is still searched from back to front. If the calculated
  682. index is less than 0, -1 is returned, i.e. the array will not be searched.</p></td>
  683. </tr>
  684. </tbody>
  685. </table>
  686. <dl class="details">
  687. <dt class="tag-source">Source:</dt>
  688. <dd class="tag-source"><ul class="dummy"><li>
  689. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line191">line 191</a>
  690. </li></ul></dd>
  691. </dl>
  692. <h5>Returns:</h5>
  693. <div class="param-desc">
  694. <p>The last index at which a given element can be found in the array, or -1 if it is not present.</p>
  695. </div>
  696. <dl>
  697. <dt>
  698. Type
  699. </dt>
  700. <dd>
  701. <span class="param-type">number</span>
  702. </dd>
  703. </dl>
  704. <h4 class="name" id="map"><span class="type-signature"></span>map<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array}</span></h4>
  705. <div class="description">
  706. <p>Creates a new array with the results of calling a provided function on every element in this array.</p>
  707. </div>
  708. <h5>This:</h5>
  709. <ul><li>{Array}</li></ul>
  710. <h5>Parameters:</h5>
  711. <table class="params">
  712. <thead>
  713. <tr>
  714. <th>Name</th>
  715. <th>Type</th>
  716. <th>Attributes</th>
  717. <th class="last">Description</th>
  718. </tr>
  719. </thead>
  720. <tbody>
  721. <tr>
  722. <td class="name"><code>_callback</code></td>
  723. <td class="type">
  724. <span class="param-type">function</span>
  725. </td>
  726. <td class="attributes">
  727. </td>
  728. <td class="description last"><p>The callback to test each value</p></td>
  729. </tr>
  730. <tr>
  731. <td class="name"><code>_thisArg</code></td>
  732. <td class="type">
  733. <span class="param-type">object</span>
  734. </td>
  735. <td class="attributes">
  736. &lt;optional><br>
  737. </td>
  738. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  739. </tr>
  740. </tbody>
  741. </table>
  742. <dl class="details">
  743. <dt class="tag-source">Source:</dt>
  744. <dd class="tag-source"><ul class="dummy"><li>
  745. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line136">line 136</a>
  746. </li></ul></dd>
  747. </dl>
  748. <h5>Returns:</h5>
  749. <div class="param-desc">
  750. <p>A new array containing the result of callback per element.</p>
  751. </div>
  752. <dl>
  753. <dt>
  754. Type
  755. </dt>
  756. <dd>
  757. <span class="param-type">Array</span>
  758. </dd>
  759. </dl>
  760. <h4 class="name" id="reduce"><span class="type-signature"></span>reduce<span class="signature">(_callback, _initialValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  761. <div class="description">
  762. <p>The reduce() method applies a function against an accumulator and each value of the
  763. array (from left-to-right) has to reduce it to a single value.</p>
  764. </div>
  765. <h5>This:</h5>
  766. <ul><li>{Array}</li></ul>
  767. <h5>Parameters:</h5>
  768. <table class="params">
  769. <thead>
  770. <tr>
  771. <th>Name</th>
  772. <th>Type</th>
  773. <th>Attributes</th>
  774. <th class="last">Description</th>
  775. </tr>
  776. </thead>
  777. <tbody>
  778. <tr>
  779. <td class="name"><code>_callback</code></td>
  780. <td class="type">
  781. <span class="param-type">function</span>
  782. </td>
  783. <td class="attributes">
  784. </td>
  785. <td class="description last"><p>The callback to call for each value, taking 4 arguments:
  786. previousValue
  787. The value previously returned in the last invocation of the callback, or initialValue, if supplied. (See below.)
  788. currentValue
  789. The current element being processed in the array.
  790. index
  791. The index of the current element being processed in the array.
  792. array
  793. The array reduce was called upon.</p></td>
  794. </tr>
  795. <tr>
  796. <td class="name"><code>_initialValue</code></td>
  797. <td class="type">
  798. <span class="param-type">object</span>
  799. </td>
  800. <td class="attributes">
  801. &lt;optional><br>
  802. </td>
  803. <td class="description last"><p>Optional: a value to pass to the first callback.</p></td>
  804. </tr>
  805. </tbody>
  806. </table>
  807. <dl class="details">
  808. <dt class="tag-source">Source:</dt>
  809. <dd class="tag-source"><ul class="dummy"><li>
  810. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line226">line 226</a>
  811. </li></ul></dd>
  812. </dl>
  813. <h4 class="name" id="reduceRight"><span class="type-signature"></span>reduceRight<span class="signature">(_callback, _initialValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  814. <div class="description">
  815. <p>The reduceRight() method applies a function against an accumulator and each value of the
  816. array (from right-to-left) has to reduce it to a single value.</p>
  817. </div>
  818. <h5>This:</h5>
  819. <ul><li>{Array}</li></ul>
  820. <h5>Parameters:</h5>
  821. <table class="params">
  822. <thead>
  823. <tr>
  824. <th>Name</th>
  825. <th>Type</th>
  826. <th>Attributes</th>
  827. <th class="last">Description</th>
  828. </tr>
  829. </thead>
  830. <tbody>
  831. <tr>
  832. <td class="name"><code>_callback</code></td>
  833. <td class="type">
  834. <span class="param-type">function</span>
  835. </td>
  836. <td class="attributes">
  837. </td>
  838. <td class="description last"><p>The callback to call for each value, taking 4 arguments:
  839. previousValue
  840. The value previously returned in the last invocation of the callback, or initialValue, if supplied. (See below.)
  841. currentValue
  842. The current element being processed in the array.
  843. index
  844. The index of the current element being processed in the array.
  845. array
  846. The array reduce was called upon.</p></td>
  847. </tr>
  848. <tr>
  849. <td class="name"><code>_initialValue</code></td>
  850. <td class="type">
  851. <span class="param-type">object</span>
  852. </td>
  853. <td class="attributes">
  854. &lt;optional><br>
  855. </td>
  856. <td class="description last"><p>Optional: a value to pass to the first callback.</p></td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. <dl class="details">
  861. <dt class="tag-source">Source:</dt>
  862. <dd class="tag-source"><ul class="dummy"><li>
  863. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line266">line 266</a>
  864. </li></ul></dd>
  865. </dl>
  866. <h4 class="name" id="some"><span class="type-signature"></span>some<span class="signature">(_callback, _thisArg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  867. <div class="description">
  868. <p>Check if callback returns true for any element</p>
  869. </div>
  870. <h5>This:</h5>
  871. <ul><li>{Array}</li></ul>
  872. <h5>Parameters:</h5>
  873. <table class="params">
  874. <thead>
  875. <tr>
  876. <th>Name</th>
  877. <th>Type</th>
  878. <th>Attributes</th>
  879. <th class="last">Description</th>
  880. </tr>
  881. </thead>
  882. <tbody>
  883. <tr>
  884. <td class="name"><code>_callback</code></td>
  885. <td class="type">
  886. <span class="param-type">function</span>
  887. </td>
  888. <td class="attributes">
  889. </td>
  890. <td class="description last"><p>The callback to test each value</p></td>
  891. </tr>
  892. <tr>
  893. <td class="name"><code>_thisArg</code></td>
  894. <td class="type">
  895. <span class="param-type">object</span>
  896. </td>
  897. <td class="attributes">
  898. &lt;optional><br>
  899. </td>
  900. <td class="description last"><p>Optional: the context in which the callback should be invoked</p></td>
  901. </tr>
  902. </tbody>
  903. </table>
  904. <dl class="details">
  905. <dt class="tag-source">Source:</dt>
  906. <dd class="tag-source"><ul class="dummy"><li>
  907. <a href="polyfill_Array.js.html">polyfill/Array.js</a>, <a href="polyfill_Array.js.html#line98">line 98</a>
  908. </li></ul></dd>
  909. </dl>
  910. <h5>Returns:</h5>
  911. <div class="param-desc">
  912. <p>True if the callback returns true for at least one element, false otherwise.</p>
  913. </div>
  914. <dl>
  915. <dt>
  916. Type
  917. </dt>
  918. <dd>
  919. <span class="param-type">boolean</span>
  920. </dd>
  921. </dl>
  922. </article>
  923. </section>
  924. </div>
  925. <nav>
  926. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-barejs.html">barejs</a></li><li><a href="module-barejs_polyfill.html">barejs/polyfill</a></li><li><a href="module-barejs_polyfill_Intl.html">barejs/polyfill/Intl</a></li></ul><h3>Classes</h3><ul><li><a href="module-barejs.decl.html">decl</a></li><li><a href="module-barejs.decl-Enum.html">Enum</a></li><li><a href="module-barejs.decl-Interface.html">Interface</a></li><li><a href="module-barejs.decl-SpecialType.html">SpecialType</a></li><li><a href="module-barejs.Destroyable.html">Destroyable</a></li><li><a href="module-barejs.EventArgs.html">EventArgs</a></li><li><a href="module-barejs.Evented.html">Evented</a></li><li><a href="module-barejs.Evented-EventedHandle.html">EventedHandle</a></li><li><a href="module-barejs.Exception.html">Exception</a></li><li><a href="module-barejs_polyfill.Array.html">Array</a></li><li><a href="module-barejs_polyfill.Date.html">Date</a></li><li><a href="module-barejs_polyfill.EntryStore.html">EntryStore</a></li><li><a href="module-barejs_polyfill.EntryStore.Iterator.html">Iterator</a></li><li><a href="module-barejs_polyfill.Function.html">Function</a></li><li><a href="module-barejs_polyfill.Map.html">Map</a></li><li><a href="module-barejs_polyfill.Map-MapIterator.html">MapIterator</a></li><li><a href="module-barejs_polyfill.Math.html">Math</a></li><li><a href="module-barejs_polyfill.Number.html">Number</a></li><li><a href="module-barejs_polyfill.Object.html">Object</a></li><li><a href="module-barejs_polyfill.Promise.html">Promise</a></li><li><a href="module-barejs_polyfill.Set.html">Set</a></li><li><a href="module-barejs_polyfill.Set-SetIterator.html">SetIterator</a></li><li><a href="module-barejs_polyfill.String.html">String</a></li><li><a href="module-barejs_polyfill.Symbol.html">Symbol</a></li><li><a href="module-barejs_polyfill.WeakMap.html">WeakMap</a></li><li><a href="module-barejs_polyfill.WeakSet.html">WeakSet</a></li><li><a href="module-barejs_polyfill_Intl.DateTimeFormat.html">DateTimeFormat</a></li><li><a href="module-barejs_polyfill_Intl.DateTimeFormat-DateTimeFormatOptions.html">DateTimeFormatOptions</a></li><li><a href="module-barejs_polyfill_Intl.NumberFormat.html">NumberFormat</a></li><li><a href="module-barejs_polyfill_Intl.NumberFormat-NumberFormatOptions.html">NumberFormatOptions</a></li><li><a href="module-barejs_polyfill_Intl-Format.html">Format</a></li></ul>
  927. </nav>
  928. <br class="clear">
  929. <footer>
  930. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Oct 03 2018 15:59:34 GMT+0200 (W. Europe Daylight Time)
  931. </footer>
  932. <script> prettyPrint(); </script>
  933. <script src="scripts/linenumber.js"> </script>
  934. </body>
  935. </html>